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.
More...
|
override void | Dispose () |
|
| ExportNotifier () |
| The default constructor creates an ExportNotifier object which is not tied to any file export. More...
|
|
| ExportNotifier (HPS.Stream.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...
|
|
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...
|
|
void | Assign (HPS.Stream.ExportNotifier in_that) |
| Associate this ExportNotifier with the same file export as the source ExportNotifier. 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...
|
|
void | Assign (HPS.IONotifier in_that) |
| Associate this IONotifier with the same file import as the source IONotifier. More...
|
|
void | Wait () |
| Cause this thread to sleep until the file import this notifier is tied to has been handled. 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 | 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...
|
|
IntPtr | GetClassID () |
|
| Object (HPS.Object that) |
|
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...
|
|
virtual bool | Empty () |
| Indicates whether this object has any values set on it. More...
|
|
virtual void | Reset () |
| Resets this object to its initial, uninitialized state. More...
|
|
bool | HasType (HPS.Type in_mask) |
| This function indicates whether this Object has the given Type mask. More...
|
|
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...
|
|
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
HandleRef | cptr |
|
HandleRef | scptr |
|
bool | cMemOwn |
|
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.
HPS.Stream.ExportNotifier.ExportNotifier |
( |
| ) |
|
|
inline |
The default constructor creates an ExportNotifier object which is not tied to any file export.
The copy constructor creates a new ExportNotifier object that is associated with the same file export as the source ExportNotifier.
- Parameters
-
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
-
override HPS.Type HPS.Stream.ExportNotifier.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.IONotifier.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.Stream.cs