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

Public Member Functions

void Assign (HPS.Exchange.TranslationNotifier in_that)
 
override void Dispose ()
 
double GetImportTime ()
 
int [] GetParasolidParts ()
 
double GetTranslationTime ()
 
override HPS.Type ObjectType ()
 
 TranslationNotifier ()
 
 TranslationNotifier (HPS.Exchange.TranslationNotifier in_that)
 
 TranslationNotifier (HPS.IONotifier in_that)
 
- Public Member Functions inherited from HPS.IONotifier
void Assign (HPS.IONotifier in_that)
 
HPS.IONotifier Cancel ()
 
 IONotifier ()
 
 IONotifier (HPS.IONotifier in_that)
 
HPS.IOResult Status ()
 
HPS.IOResult Status (out float out_percent_complete)
 
HPS.IONotifier Wait ()
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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
 

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

◆ TranslationNotifier() [1/3]

HPS.Exchange.TranslationNotifier.TranslationNotifier ( )
inline

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

◆ TranslationNotifier() [2/3]

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 TranslationNotifier to copy.

◆ TranslationNotifier() [3/3]

HPS.Exchange.TranslationNotifier.TranslationNotifier ( HPS.IONotifier  in_that)
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_thatThe source IONotifier to copy.

Member Function Documentation

◆ Assign()

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 TranslationNotifier for the assignment.

◆ GetImportTime()

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.

◆ GetParasolidParts()

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.

◆ GetTranslationTime()

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.

◆ ObjectType()

override HPS.Type HPS.Exchange.TranslationNotifier.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived 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