HPS::Exchange::ExportNotifier Class Reference

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::ExportNotifier:
HPS::IONotifier HPS::Object

Public Member Functions

void Assign (ExportNotifier const &in_that)
 
 ExportNotifier ()
 
 ExportNotifier (ExportNotifier const &in_that)
 
 ExportNotifier (IONotifier const &in_that)
 
 ExportNotifier (ExportNotifier &&in_that)
 
A3DAsmModelFile * GetModelFile () const
 
HPS::Type ObjectType () const
 
ExportNotifieroperator= (ExportNotifier &&in_that)
 
ExportNotifieroperator= (ExportNotifier const &in_that)
 
- Public Member Functions inherited from HPS::IONotifier
void Assign (IONotifier const &in_that)
 
IONotifierCancel ()
 
 IONotifier ()
 
 IONotifier (IONotifier const &in_that)
 
 IONotifier (IONotifier &&in_that)
 
IONotifieroperator= (IONotifier &&in_that)
 
IONotifieroperator= (IONotifier const &in_that)
 
IOResult Status () const
 
IOResult Status (float &out_percent_complete) const
 
IONotifierWait ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::ExchangeExportNotifier
 
- Static Public Attributes inherited from HPS::IONotifier
static const HPS::Type staticType = HPS::Type::IONotifier
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ ExportNotifier() [1/4]

HPS::Exchange::ExportNotifier::ExportNotifier ( )

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

◆ ExportNotifier() [2/4]

HPS::Exchange::ExportNotifier::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_thatThe source ExportNotifier to copy.

◆ ExportNotifier() [3/4]

HPS::Exchange::ExportNotifier::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_thatThe source IONotifier to copy.

◆ ExportNotifier() [4/4]

HPS::Exchange::ExportNotifier::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_thatAn rvalue reference to an ExportNotifier to take the underlying object from.

Member Function Documentation

◆ Assign()

void HPS::Exchange::ExportNotifier::Assign ( ExportNotifier const &  in_that)

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

Parameters
in_thatThe source ExportNotifier for the assignment.

◆ GetModelFile()

A3DAsmModelFile* HPS::Exchange::ExportNotifier::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.

◆ ObjectType()

HPS::Type HPS::Exchange::ExportNotifier::ObjectType ( ) const
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.

◆ operator=() [1/2]

ExportNotifier& HPS::Exchange::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_thatAn rvalue reference to an ExportNotifier to take the underlying object from.
Returns
A reference to this ExportNotifier.

◆ operator=() [2/2]

ExportNotifier& HPS::Exchange::ExportNotifier::operator= ( ExportNotifier const &  in_that)

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

Parameters
in_thatThe source ExportNotifier for the assignment.
Returns
A reference to this ExportNotifier.

The documentation for this class was generated from the following file: