API Search || Global Search
HPS.Exchange.ImportNotifier Class Reference

More...

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

Public Member Functions

void Assign (HPS.Exchange.ImportNotifier in_that)
 Associate this ImportNotifier with the same file import as the source ImportNotifier. More...
 
override void Dispose ()
 
HPS.Exchange.CADModel GetCADModel ()
 Get the CADModel for the file import. Throws an IOException if the import 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 import is not complete, was not successful or was canceled. More...
 
double GetParseTime ()
 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. More...
 
IntPtr GetPRCReadHelper ()
 Get the PRC Read Helper for the file import. Throws an IOException if the import is not complete, was not successful or was canceled. The returned value will only be non-null if the Exchange.ImportOptionsKit.SetPRCReadHelper option was set to true and the file that was imported was a PRC file or a PRC stream. More...
 
 ImportNotifier ()
 The default constructor creates an ImportNotifier object which is not tied to any file import. More...
 
 ImportNotifier (HPS.Exchange.ImportNotifier in_that)
 The copy constructor creates a new ImportNotifier object that is associated with the same file import as the source ImportNotifier. More...
 
 ImportNotifier (HPS.IONotifier in_that)
 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. More...
 
override HPS.Type ObjectType ()
 
- Public Member Functions inherited from HPS.IONotifier
void Assign (HPS.IONotifier in_that)
 Associate this IONotifier with the same file IO operation as the source IONotifier. More...
 
HPS.IONotifier Cancel ()
 Requests to cancel the asynchronous file IO if it is still in progress. The Cancel() function will return synchronously, however there may be some delay between when the cancel request is made and when the asynchronous file IO stops. Call Wait() to ensure that the asynchronous file IO operation has stopped. More...
 
 IONotifier ()
 The default constructor creates an IONotifier object which is not associated with any file IO operation. More...
 
 IONotifier (HPS.IONotifier in_that)
 The copy constructor creates a new IONotifier object that is associated with the same file IO as the source IONotifier. More...
 
HPS.IOResult Status ()
 Query the status of the file IO operation for this notifier. More...
 
HPS.IOResult Status (out float out_percent_complete)
 Query the status and completion percentage of the file IO for this notifier. More...
 
HPS.IONotifier Wait ()
 Cause this thread to sleep until the asynchronous file IO operation associated with this notifier is complete. 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. 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...
 
virtual 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 ()
 
- 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

HPS.Exchange.ImportNotifier.ImportNotifier ( )
inline

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

HPS.Exchange.ImportNotifier.ImportNotifier ( HPS.Exchange.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.
HPS.Exchange.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

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

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

Parameters
in_thatThe source ImportNotifier for the assignment.
HPS.Exchange.CADModel HPS.Exchange.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.
double HPS.Exchange.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.

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

IntPtr HPS.Exchange.ImportNotifier.GetPRCReadHelper ( )
inline

Get the PRC Read Helper for the file import. Throws an IOException if the import is not complete, was not successful or was canceled. The returned value will only be non-null if the Exchange.ImportOptionsKit.SetPRCReadHelper option was set to true and the file that was imported was a PRC file or a PRC stream.

Returns
The A3DRWParamsPrcReadHelper * created during a successful file import.

Exchange.ImportOptionsKit.SetPRCReadHelper


The documentation for this class was generated from the following file:
  • internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs