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(ExportNotifier const &in_that)
Associate this ExportNotifier with the same file export as the source ExportNotifier.
- Parameters
in_that – The source ExportNotifier for the assignment.
-
ExportNotifier()
The default constructor creates an ExportNotifier object which is not tied to any file export.
-
ExportNotifier(ExportNotifier &&in_that)
The move constructor creates an ExportNotifier by transferring the underlying object of the rvalue reference to this ExportNotifier thereby avoiding a copy and allocation.
- Parameters
in_that – An rvalue reference to an ExportNotifier to take the underlying object from.
-
ExportNotifier(ExportNotifier const &in_that)
The copy constructor creates a new ExportNotifier object that is associated with the same file export as the source ExportNotifier.
- Parameters
in_that – The source ExportNotifier to copy.
-
ExportNotifier(IONotifier const &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.
- Parameters
in_that – The source IONotifier to copy.
-
A3DAsmModelFile *GetModelFile() const
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.
- Returns
The A3DAsmModelFile for a successful file export.
-
inline virtual HPS::Type ObjectType() const
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.
-
ExportNotifier &operator=(ExportNotifier &&in_that)
The move assignment operator transfers the underlying object of the rvalue reference to this ExportNotifier thereby avoiding a copy.
- Parameters
in_that – An rvalue reference to an ExportNotifier to take the underlying object from.
- Returns
A reference to this ExportNotifier.
-
ExportNotifier &operator=(ExportNotifier const &in_that)
Associate this ExportNotifier with the same file export as the source ExportNotifier.
- Parameters
in_that – The source ExportNotifier for the assignment.
- Returns
A reference to this ExportNotifier.
-
virtual ~ExportNotifier()
Public Static Attributes
-
static const HPS::Type staticType = HPS::Type::ExchangeExportNotifier
-
void Assign(ExportNotifier const &in_that)
