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. More...
Public Member Functions | |
override void | Dispose () |
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 copy constructor creates a new ImportNotifier object that is associated with the same file import as the source ImportNotifier. 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.Sketchup.ImportNotifier in_that) |
Associate this ImportNotifier with the same file import as the source ImportNotifier. More... | |
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... | |
![]() | |
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 in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. 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... | |
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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
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.
|
inline |
The default constructor creates an ImportNotifier object which is not tied to any file import.
|
inline |
The copy constructor creates a new ImportNotifier object that is associated with the same file import as the source ImportNotifier.
in_that | The source <ref refid="class_h_p_s_1_1_sketchup_1_1_import_notifier" kindref="compound">ImportNotifier</ref> to copy. |
|
inline |
The copy constructor creates a new ImportNotifier object that is associated with the same file import as the source ImportNotifier.
in_that | The source <ref refid="class_h_p_s_1_1_sketchup_1_1_import_notifier" kindref="compound">ImportNotifier</ref> to copy. |
|
inline |
Associate this ImportNotifier with the same file import as the source ImportNotifier.
in_that | The source <ref refid="class_h_p_s_1_1_sketchup_1_1_import_notifier" kindref="compound">ImportNotifier</ref> for the assignment. |
|
inline |
Get the ImportResultsKit for the file import. Throws an IOException if the import is not complete or was not successful.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.IONotifier.