< Home

< Table of Contents

REFERENCE MANUAL

HPS.Exchange.ExportNotifier Class Reference

The ExportNotifier class is a smart-pointer that is tied to a file export. More...

Inheritance diagram for HPS.Exchange.ExportNotifier:
HPS.IONotifier HPS.Object

Public Member Functions

void Assign (HPS.Exchange.ExportNotifier in_that)
 Associate this ExportNotifier with the same file export as the source ExportNotifier. More...
 
override void Dispose ()
 
 ExportNotifier ()
 The default constructor creates an ExportNotifier object which is not tied to any file export. More...
 
 ExportNotifier (HPS.Exchange.ExportNotifier in_that)
 The copy constructor creates a new ExportNotifier object that is associated with the same file export as the source ExportNotifier. More...
 
 ExportNotifier (HPS.IONotifier in_that)
 The copy constructor creates a new ExportNotifier object that is associated with the same file export as the source ExportNotifier. More...
 
IntPtr GetModelFile ()
 Get the A3DAsmModelFile created during the export. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
- Public Member Functions inherited from HPS.IONotifier
void Assign (HPS.IONotifier in_that)
 Associate this IONotifier with the same file import as the source IONotifier. More...
 
void Cancel ()
 Cancels the import if it is still in progress. More...
 
 IONotifier ()
 The default constructor creates an IONotifier object which is not tied to any file import. More...
 
 IONotifier (HPS.IONotifier in_that)
 The copy constructor creates a new IONotifier object that is associated with the same file import as the source IONotifier. More...
 
HPS.IOResult Status ()
 Query the status of the file import this notifier is tied to. More...
 
HPS.IOResult Status (out float out_percent_complete)
 Query the status of the file import this notifier is tied to and its percentage complete. More...
 
void Wait ()
 Cause this thread to sleep until the file import this notifier is tied to has been handled. More...
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The ExportNotifier class is a smart-pointer that is tied to a file export.

It is used to interact with an ongoing export or get the results from a completed export.

Constructor & Destructor Documentation

HPS.Exchange.ExportNotifier.ExportNotifier ( )

The default constructor creates an ExportNotifier object which is not tied to any file export.

HPS.Exchange.ExportNotifier.ExportNotifier ( HPS.Exchange.ExportNotifier  in_that)

The copy constructor creates a new ExportNotifier object that is associated with the same file export as the source ExportNotifier.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_exchange_1_1_export_notifier" kindref="compound">ExportNotifier</ref> to copy.
HPS.Exchange.ExportNotifier.ExportNotifier ( HPS.IONotifier  in_that)

The copy constructor creates a new ExportNotifier object that is associated with the same file export as the source ExportNotifier.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_exchange_1_1_export_notifier" kindref="compound">ExportNotifier</ref> to copy.

Member Function Documentation

void HPS.Exchange.ExportNotifier.Assign ( HPS.Exchange.ExportNotifier  in_that)

Associate this ExportNotifier with the same file export as the source ExportNotifier.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_exchange_1_1_export_notifier" kindref="compound">ExportNotifier</ref> for the assignment.
IntPtr HPS.Exchange.ExportNotifier.GetModelFile ( )

Get the A3DAsmModelFile created during the export.

Throws an IOException if the export is not complete, was not successful or was canceled. It will be up to the user to delete this A3DAsmModelFile via <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/group__a3d__modelfile.html#ga147b1bb7013909e3eacea23bb5bf80c2">A3DAsmModelFileDelete</ulink>.

Returns
The A3DAsmModelFile for a successful file export.
override HPS.Type HPS.Exchange.ExportNotifier.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.IONotifier.


The documentation for this class was generated from the following file: