HPS::Exchange::ImportNotifier

class HPS.Exchange.ImportNotifier : public HPS.IONotifier 

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.

Public Functions

void Assign (HPS.Exchange.ImportNotifier in_that)

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

Param in_that: The source ImportNotifier for the assignment.

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.

Return: The CADModel for a successful file import.

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.

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.

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.

See: Exchange.ImportOptionsKit.SetPRCReadHelper

Return: The A3DRWParamsPrcReadHelper * created during a successful file import.

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

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.

Param in_that: The source ImportNotifier to copy.

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.

Param in_that: The source IONotifier to copy.

override HPS.Type ObjectType ()

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

Return: The declared type of the object in question, which may differ from the true, underlying type.