
Public Member Functions | |
void | Assign (HPS.Sketchup.ImportNotifier in_that) |
Associate this ImportNotifier with the same file import as the source ImportNotifier. More... | |
override void | Dispose () |
HPS.Sketchup.ImportResultsKit | GetResults () |
Get the ImportResultsKit for the file import. Throws an IOException if the import is not complete or was not successful. More... | |
ImportNotifier () | |
The default constructor creates an ImportNotifier object which is not tied to any file import. More... | |
ImportNotifier (HPS.Sketchup.ImportNotifier in_that) | |
The copy constructor creates a new ImportNotifier object that is associated with the same file import as the source ImportNotifier. More... | |
ImportNotifier (HPS.IONotifier in_that) | |
The conversion constructor creates a new derived ImportNotifier 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 ImportNotifier will be invalid. 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... | |
![]() | |
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... | |
![]() | |
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 () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The ImportNotifier 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.
Constructor & Destructor Documentation
◆ ImportNotifier() [1/3]
|
inline |
The default constructor creates an ImportNotifier object which is not tied to any file import.
◆ ImportNotifier() [2/3]
|
inline |
The copy constructor creates a new ImportNotifier object that is associated with the same file import as the source ImportNotifier.
- Parameters
-
in_that The source ImportNotifier to copy.
◆ ImportNotifier() [3/3]
|
inline |
The conversion constructor creates a new derived ImportNotifier 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 ImportNotifier will be invalid.
- Parameters
-
in_that The source IONotifier to copy.
Member Function Documentation
◆ Assign()
|
inline |
Associate this ImportNotifier with the same file import as the source ImportNotifier.
- Parameters
-
in_that The source ImportNotifier for the assignment.
◆ GetResults()
|
inline |
Get the ImportResultsKit for the file import. Throws an IOException if the import is not complete or was not successful.
- Returns
- The ImportResultsKit for a successful file import.
◆ 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.IONotifier.
The documentation for this class was generated from the following file:
- internals/hps_sprk_sketchup/source/cs/HPS.Sketchup.cs