< Home

< Table of Contents

REFERENCE MANUAL

HPS.Exchange.TranslationNotifier Class Reference

The TranslationNotifier class is a smart-pointer that is tied to a file translation. More...

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

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 GetModelLoadTime ()
 Get time it took Exchange to load the model into memory More...
 
int[] GetParasolidParts ()
 Get the Parasolid parts obtained from the translation. More...
 
double GetTranslationTime ()
 Get time it took Exchange translate the model into Parasolid parts More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. 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 copy constructor creates a new TranslationNotifier object that is associated with the same file translation as the source TranslationNotifier. More...
 
- Public Member Functions inherited from HPS.IONotifier
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...
 
- Public Member Functions inherited from HPS.Object
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 ()
 
- 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
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

HPS.Exchange.TranslationNotifier.TranslationNotifier ( )

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

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

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)

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)

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.GetModelLoadTime ( )

Get time it took Exchange to load the model into memory

Returns
The time it took Exchange to load the model into memory. Specified in seconds
int [] HPS.Exchange.TranslationNotifier.GetParasolidParts ( )

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 ( )

Get time it took Exchange translate the model into Parasolid parts

Returns
The time it took Exchange to translate the model into Parasolid parts. Specified in seconds
override HPS.Type HPS.Exchange.TranslationNotifier.ObjectType ( )
virtual

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: