The TranslationNotifier class is a smart-pointer that is tied to a file translation. It is used to interact with an ongoing translation or get the results from a completed translation. More...

Public Member Functions | |
void | Assign (HPS.Exchange.TranslationNotifier in_that) |
Associate this TranslationNotifier with the same file translation as the source TranslationNotifier. More... | |
override void | Dispose () |
double | GetImportTime () |
Get the number of milliseconds it took Exchange to read the CAD file(s) and generate the corresponding PRC data. Throws an IOException if the translation is not complete, was not successful or was canceled. More... | |
int[] | GetParasolidParts () |
Get the Parasolid parts obtained from the translation. Throws an IOException if the translation is not complete, was not successful or was canceled. More... | |
double | GetTranslationTime () |
Get the number of milliseconds it took Exchange to translate the PRC data into Parasolid data. Throws an IOException if the translation is not complete, was not successful or was canceled. 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... | |
TranslationNotifier () | |
The default constructor creates an TranslationNotifier object which is not tied to any file translation. More... | |
TranslationNotifier (HPS.Exchange.TranslationNotifier in_that) | |
The copy constructor creates a new TranslationNotifier object that is associated with the same file translation as the source TranslationNotifier. More... | |
TranslationNotifier (HPS.IONotifier in_that) | |
The conversion constructor creates a new derived TranslationNotifier 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 TranslationNotifier will be invalid. 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... | |
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. 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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
Detailed Description
The TranslationNotifier class is a smart-pointer that is tied to a file translation. It is used to interact with an ongoing translation or get the results from a completed translation.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an TranslationNotifier object which is not tied to any file translation.
|
inline |
The copy constructor creates a new TranslationNotifier object that is associated with the same file translation as the source TranslationNotifier.
- Parameters
-
in_that The source TranslationNotifier to copy.
|
inline |
The conversion constructor creates a new derived TranslationNotifier 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 TranslationNotifier will be invalid.
- Parameters
-
in_that The source IONotifier to copy.
Member Function Documentation
|
inline |
Associate this TranslationNotifier with the same file translation as the source TranslationNotifier.
- Parameters
-
in_that The source TranslationNotifier for the assignment.
|
inline |
Get the number of milliseconds it took Exchange to read the CAD file(s) and generate the corresponding PRC data. Throws an IOException if the translation is not complete, was not successful or was canceled.
|
inline |
Get the Parasolid parts obtained from the translation. Throws an IOException if the translation is not complete, was not successful or was canceled.
- Returns
- The Parasolid Parts for a successful file translation.
|
inline |
Get the number of milliseconds it took Exchange to translate the PRC data into Parasolid data. Throws an IOException if the translation is not complete, was not successful or was canceled.
|
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_sprk_exchange/source/cs/HPS.Exchange.cs