The IONotifier class is a smart-pointer that is tied to a file import. It is used to interact with an ongoing import or get the results from a completed import.
More...
|
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. There may be some delay between when the cancel request is made and when the import stops and any associated data is deleted as the importer checks for a cancel request periodically during import. More...
|
|
override void | Dispose () |
|
| 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...
|
|
override HPS.Type | ObjectType () |
| This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. 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...
|
|
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...
|
|
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 |
|
HandleRef | scptr |
|
The IONotifier class is a smart-pointer that is tied to a file import. It is used to interact with an ongoing import or get the results from a completed import.
HPS.IONotifier.IONotifier |
( |
| ) |
|
|
inline |
The default constructor creates an IONotifier object which is not tied to any file import.
The copy constructor creates a new IONotifier object that is associated with the same file import as the source IONotifier.
- Parameters
-
void HPS.IONotifier.Cancel |
( |
| ) |
|
|
inline |
Cancels the import if it is still in progress. There may be some delay between when the cancel request is made and when the import stops and any associated data is deleted as the importer checks for a cancel request periodically during import.
override HPS.Type HPS.IONotifier.ObjectType |
( |
| ) |
|
|
inlinevirtual |
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.Object.
Reimplemented in HPS.Stream.ExportNotifier, HPS.Exchange.ExportNotifier, HPS.Exchange.ImportNotifier, HPS.Exchange.ReloadNotifier, HPS.Exchange.TranslationNotifier, HPS.OBJ.ImportNotifier, HPS.STL.ImportNotifier, and HPS.Stream.ImportNotifier.
HPS.IOResult HPS.IONotifier.Status |
( |
| ) |
|
|
inline |
Query the status of the file import this notifier is tied to.
- Returns
- The current state of the file import.
HPS.IOResult HPS.IONotifier.Status |
( |
out float |
out_percent_complete | ) |
|
|
inline |
Query the status of the file import this notifier is tied to and its percentage complete.
- Parameters
-
out_percent_complete | Float in the range [0,1] indicating the current percentage complete. |
- Returns
- The current state of the file import.
void HPS.IONotifier.Wait |
( |
| ) |
|
|
inline |
Cause this thread to sleep until the file import this notifier is tied to has been handled.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.IONotifier.cs