HPS.ExchangeParasolid.ImportNotifier Class Reference
Inheritance diagram for HPS.ExchangeParasolid.ImportNotifier:
HPS.IONotifier HPS.Object

Public Member Functions

void Assign (HPS.ExchangeParasolid.ImportNotifier in_that)
 
override void Dispose ()
 
HPS.Exchange.CADModel GetCADModel ()
 
double GetImportTime ()
 
double GetParseTime ()
 
double GetTranslationTime ()
 
 ImportNotifier ()
 
 ImportNotifier (HPS.ExchangeParasolid.ImportNotifier in_that)
 
 ImportNotifier (HPS.IONotifier in_that)
 
override HPS.Type ObjectType ()
 
- 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 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.

Constructor & Destructor Documentation

◆ ImportNotifier() [1/3]

HPS.ExchangeParasolid.ImportNotifier.ImportNotifier ( )
inline

The default constructor creates an ImportNotifier object which is not tied to any file import.

◆ ImportNotifier() [2/3]

HPS.ExchangeParasolid.ImportNotifier.ImportNotifier ( HPS.ExchangeParasolid.ImportNotifier  in_that)
inline

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

Parameters
in_thatThe source ImportNotifier to copy.

◆ ImportNotifier() [3/3]

HPS.ExchangeParasolid.ImportNotifier.ImportNotifier ( HPS.IONotifier  in_that)
inline

The conversion constructor creates a new derived ImportNotifier 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 ImportNotifier will be invalid.

Parameters
in_thatThe source IONotifier to copy.

Member Function Documentation

◆ Assign()

void HPS.ExchangeParasolid.ImportNotifier.Assign ( HPS.ExchangeParasolid.ImportNotifier  in_that)
inline

Associate this ImportNotifier with the same file import as the source ImportNotifier.

Parameters
in_thatThe source ImportNotifier for the assignment.

◆ GetCADModel()

HPS.Exchange.CADModel HPS.ExchangeParasolid.ImportNotifier.GetCADModel ( )
inline

Get the CADModel for the file import. Throws an IOException if the import is not complete, was not successful or was canceled.

Returns
The CADModel for a successful file import.

◆ GetImportTime()

double HPS.ExchangeParasolid.ImportNotifier.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 import is not complete, was not successful or was canceled.

◆ GetParseTime()

double HPS.ExchangeParasolid.ImportNotifier.GetParseTime ( )
inline

Get the number of milliseconds it took Visualize to parse the PRC data and create the corresponding scene graph. Throws an IOException if the import is not complete, was not successful or was canceled.

◆ GetTranslationTime()

double HPS.ExchangeParasolid.ImportNotifier.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.ExchangeParasolid.ImportNotifier.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_parasolid/source/cs/HPS.ExchangeParasolid.cs