HPS::Exchange::ExportNotifier

class HPS.Exchange.ExportNotifier : public HPS.IONotifier

The ExportNotifier class is a smart-pointer that is tied to a file export. It is used to interact with an ongoing export or get the results from a completed export.

Public Functions

void Assign (HPS.Exchange.ExportNotifier in_that)

Associate this ExportNotifier with the same file export as the source ExportNotifier.

Param in_that

The source ExportNotifier for the assignment.

override void Dispose ()

ExportNotifier ()

The default constructor creates an ExportNotifier object which is not tied to any file export.

ExportNotifier (HPS.Exchange.ExportNotifier in_that)

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

Param in_that

The source ExportNotifier to copy.

ExportNotifier (HPS.IONotifier in_that)

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

Param in_that

The source IONotifier to copy.

IntPtr GetModelFile ()

Get the A3DAsmModelFile created during the export. Throws an IOException if the export is not complete, was not successful or was canceled. It will be up to the user to delete this A3DAsmModelFile via A3DAsmModelFileDelete.

Return

The A3DAsmModelFile for a successful file export.

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.