REFERENCE MANUAL
The ImportNotifier class is a smart-pointer that is tied to a file import. More...
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. 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 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. 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. 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... | |
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. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
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... | |
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. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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.
HPS.Sketchup.ImportNotifier.ImportNotifier | ( | ) |
The default constructor creates an ImportNotifier object which is not tied to any file import.
HPS.Sketchup.ImportNotifier.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.
in_that | The source <ref refid="class_h_p_s_1_1_sketchup_1_1_import_notifier" kindref="compound">ImportNotifier</ref> to copy. |
HPS.Sketchup.ImportNotifier.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.
in_that | The source <ref refid="class_h_p_s_1_1_sketchup_1_1_import_notifier" kindref="compound">ImportNotifier</ref> to copy. |
void HPS.Sketchup.ImportNotifier.Assign | ( | HPS.Sketchup.ImportNotifier | in_that | ) |
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. |
HPS.Sketchup.ImportResultsKit HPS.Sketchup.ImportNotifier.GetResults | ( | ) |
Get the ImportResultsKit for the file import.
Throws an IOException if the import is not complete or was not successful.
|
virtual |
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.