#include <hps.h>

Public Member Functions | |
void | Assign (ExportNotifier const &in_that) |
ExportNotifier () | |
ExportNotifier (ExportNotifier const &in_that) | |
ExportNotifier (IONotifier const &in_that) | |
ExportNotifier (ExportNotifier &&in_that) | |
HPS::Type | ObjectType () const |
ExportNotifier & | operator= (ExportNotifier &&in_that) |
ExportNotifier & | operator= (ExportNotifier const &in_that) |
![]() | |
void | Assign (IONotifier const &in_that) |
IONotifier & | Cancel () |
IONotifier () | |
IONotifier (IONotifier const &in_that) | |
IONotifier (IONotifier &&in_that) | |
IONotifier & | operator= (IONotifier &&in_that) |
IONotifier & | operator= (IONotifier const &in_that) |
IOResult | Status () const |
IOResult | Status (float &out_percent_complete) const |
IONotifier & | Wait () |
![]() | |
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) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::OBJExportNotifier |
![]() | |
static const HPS::Type | staticType = HPS::Type::IONotifier |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
The ExportNotifier class is a smart-pointer that is associated with an asynchronous 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::OBJ::ExportNotifier::ExportNotifier | ( | ) |
The default constructor creates an ExportNotifier object which is not associated with any file export.
◆ ExportNotifier() [2/4]
HPS::OBJ::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_that The source ExportNotifier to copy.
◆ ExportNotifier() [3/4]
HPS::OBJ::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_that The source IONotifier to copy.
◆ ExportNotifier() [4/4]
HPS::OBJ::ExportNotifier::ExportNotifier | ( | ExportNotifier && | in_that | ) |
The move constructor creates an ExportNotifier by transferring the underlying impl 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 impl from.
Member Function Documentation
◆ Assign()
void HPS::OBJ::ExportNotifier::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.
◆ ObjectType()
|
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::OBJ::ExportNotifier::operator= | ( | ExportNotifier && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ExportNotifier thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to an ExportNotifier to take the impl from.
- Returns
- A reference to this ExportNotifier.
◆ operator=() [2/2]
ExportNotifier& HPS::OBJ::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.
The documentation for this class was generated from the following file:
- include/hps.h