API Search || Global Search
HPS.Exchange.ExportNotifier Class Reference

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 conversion constructor creates a new derived ExportNotifier object from a base IONotifier object. The copy will only be successful if the source notifier is really an upcast of this notifier type. Otherwise the copy will fail and the resulting ExportNotifier will be invalid. More...
 
IntPtr 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 A3DAsmModelFileDelete. More...
 
override HPS.Type ObjectType ()
 
- Public Member Functions inherited from HPS.IONotifier
void Assign (HPS.IONotifier in_that)
 Associate this IONotifier with the same file IO operation as the source IONotifier. More...
 
HPS.IONotifier Cancel ()
 Requests to cancel the asynchronous file IO if it is still in progress. The Cancel() function will return synchronously, however there may be some delay between when the cancel request is made and when the asynchronous file IO stops. Call Wait() to ensure that the asynchronous file IO operation has stopped. More...
 
 IONotifier ()
 The default constructor creates an IONotifier object which is not associated with any file IO operation. More...
 
 IONotifier (HPS.IONotifier in_that)
 The copy constructor creates a new IONotifier object that is associated with the same file IO as the source IONotifier. More...
 
HPS.IOResult Status ()
 Query the status of the file IO operation for this notifier. More...
 
HPS.IOResult Status (out float out_percent_complete)
 Query the status and completion percentage of the file IO for this notifier. More...
 
HPS.IONotifier Wait ()
 Cause this thread to sleep until the asynchronous file IO operation associated with this notifier is complete. 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 the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
virtual HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. 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
 

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 ( )
inline

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

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

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

Parameters
in_thatThe source ExportNotifier to copy.
HPS.Exchange.ExportNotifier.ExportNotifier ( HPS.IONotifier  in_that)
inline

The conversion constructor creates a new derived ExportNotifier object from a base IONotifier object. The copy will only be successful if the source notifier is really an upcast of this notifier type. Otherwise the copy will fail and the resulting ExportNotifier will be invalid.

Parameters
in_thatThe source IONotifier to copy.

Member Function Documentation

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

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

Parameters
in_thatThe source ExportNotifier for the assignment.
IntPtr HPS.Exchange.ExportNotifier.GetModelFile ( )
inline

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 A3DAsmModelFileDelete.

Returns
The A3DAsmModelFile for a successful file export.

The documentation for this class was generated from the following file:
  • internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs