More...
|
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 () |
| This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object). 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...
|
|
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...
|
|
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ IONotifier() [1/2]
HPS.IONotifier.IONotifier |
( |
| ) |
|
|
inline |
The default constructor creates an IONotifier object which is not associated with any file IO operation.
◆ IONotifier() [2/2]
The copy constructor creates a new IONotifier object that is associated with the same file IO as the source IONotifier.
- Parameters
-
◆ Assign()
◆ 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.
- Returns
- A reference to this IONotifier.
◆ ObjectType()
override HPS.Type HPS.IONotifier.ObjectType |
( |
| ) |
|
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
Reimplemented in HPS.Stream.ExportNotifier, HPS.Exchange.ExportNotifier, HPS.Parasolid.ImportNotifier, HPS.Exchange.ImportNotifier, HPS.Exchange.ReloadNotifier, HPS.Exchange.TranslationNotifier, HPS.OOC.ImportNotifier, HPS.DWG.ImportNotifier, HPS.OBJ.ExportNotifier, HPS.OBJ.ImportNotifier, HPS.STL.ImportNotifier, HPS.PointCloud.ImportNotifier, HPS.Sketchup.ImportNotifier, HPS.Stream.ImportNotifier, and HPS.ExchangeParasolid.ImportNotifier.
◆ Status() [1/2]
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.
◆ Status() [2/2]
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_complete | Float in the range [0,1] indicating the current percentage complete. |
- Returns
- The current state of the file import.
◆ Wait()
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