Public Member Functions | Protected Member Functions | List of all members
HPS.Exchange.TranslationNotifier Class Reference

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...

Inheritance diagram for HPS.Exchange.TranslationNotifier:
HPS.IONotifier HPS.Object

Public Member Functions

override void Dispose ()
 
 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 copy constructor creates a new TranslationNotifier object that is associated with the same file translation as the source TranslationNotifier. 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.Exchange.TranslationNotifier in_that)
 Associate this TranslationNotifier with the same file translation as the source TranslationNotifier. 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 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...
 
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...
 
- Public Member Functions inherited from HPS.IONotifier
 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...
 
- Public Member Functions inherited from HPS.Object
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 ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

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

HPS.Exchange.TranslationNotifier.TranslationNotifier ( )
inline

The default constructor creates an TranslationNotifier object which is not tied to any file translation.

HPS.Exchange.TranslationNotifier.TranslationNotifier ( HPS.Exchange.TranslationNotifier  in_that)
inline

The copy constructor creates a new TranslationNotifier object that is associated with the same file translation as the source TranslationNotifier.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_exchange_1_1_translation_notifier" kindref="compound">TranslationNotifier</ref> to copy.
HPS.Exchange.TranslationNotifier.TranslationNotifier ( HPS.IONotifier  in_that)
inline

The copy constructor creates a new TranslationNotifier object that is associated with the same file translation as the source TranslationNotifier.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_exchange_1_1_translation_notifier" kindref="compound">TranslationNotifier</ref> to copy.

Member Function Documentation

void HPS.Exchange.TranslationNotifier.Assign ( HPS.Exchange.TranslationNotifier  in_that)
inline

Associate this TranslationNotifier with the same file translation as the source TranslationNotifier.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_exchange_1_1_translation_notifier" kindref="compound">TranslationNotifier</ref> for the assignment.
double HPS.Exchange.TranslationNotifier.GetImportTime ( )
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.

int [] HPS.Exchange.TranslationNotifier.GetParasolidParts ( )
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.
double HPS.Exchange.TranslationNotifier.GetTranslationTime ( )
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.

override HPS.Type HPS.Exchange.TranslationNotifier.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: