API Search || Global Search

More...

Inheritance diagram for HPS.IONotifier:
HPS.Object HPS.DWG.ImportNotifier HPS.Exchange.ExportNotifier HPS.Exchange.ImportNotifier HPS.Exchange.ReloadNotifier HPS.Exchange.TranslationNotifier HPS.ExchangeParasolid.ImportNotifier HPS.OBJ.ExportNotifier HPS.OBJ.ImportNotifier HPS.OOC.ImportNotifier HPS.Parasolid.ImportNotifier HPS.PointCloud.ImportNotifier HPS.Sketchup.ImportNotifier HPS.STL.ImportNotifier HPS.Stream.ExportNotifier HPS.Stream.ImportNotifier

Public Member Functions

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...
 
override void Dispose ()
 
 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...
 
override HPS.Type ObjectType ()
 
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 an identifier that can be used to identify which instance of a class an object is. 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 IONotifier class is a smart-pointer that is associated with an asynchronous file import or export. It is used to interact with an ongoing file IO or get the results from a completed IO operation.

Constructor & Destructor Documentation

HPS.IONotifier.IONotifier ( )
inline

The default constructor creates an IONotifier object which is not associated with any file IO operation.

HPS.IONotifier.IONotifier ( HPS.IONotifier  in_that)
inline

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

Parameters
in_thatThe source IONotifier to copy.

Member Function Documentation

void HPS.IONotifier.Assign ( HPS.IONotifier  in_that)
inline

Associate this IONotifier with the same file IO operation as the source IONotifier.

Parameters
in_thatThe source IONotifier for the assignment.
HPS.IONotifier HPS.IONotifier.Cancel ( )
inline

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.

Returns
    A reference to this IONotifier.
HPS.IOResult HPS.IONotifier.Status ( )
inline

Query the status of the file IO operation for this notifier.

Returns
    The current state of the file import.
HPS.IOResult HPS.IONotifier.Status ( out float  out_percent_complete)
inline

Query the status and completion percentage of the file IO for this notifier.

Parameters
out_percent_completeFloat in the range [0,1] indicating the current percentage complete.
Returns
    The current state of the file import.
HPS.IONotifier HPS.IONotifier.Wait ( )
inline

Cause this thread to sleep until the asynchronous file IO operation associated with this notifier is complete.

Returns
    A reference to this IONotifier.

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