REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
void | Assign (ImportNotifier const &in_that) |
ImportResultsKit | GetResults () const |
ImportNotifier () | |
ImportNotifier (ImportNotifier const &in_that) | |
ImportNotifier (IONotifier const &in_that) | |
ImportNotifier (ImportNotifier &&in_that) | |
Type | ObjectType () const |
ImportNotifier & | operator= (ImportNotifier &&in_that) |
ImportNotifier & | operator= (ImportNotifier const &in_that) |
![]() | |
void | Assign (IONotifier const &in_that) |
void | 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 |
void | Wait () |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
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.
Stream::ImportNotifier::ImportNotifier | ( | ) |
The default constructor creates an ImportNotifier object which is not tied to any file import.
Stream::ImportNotifier::ImportNotifier | ( | ImportNotifier const & | in_that | ) |
The copy constructor creates a new ImportNotifier object that is associated with the same file import as the source ImportNotifier.
in_that | The source ImportNotifier to copy. |
Stream::ImportNotifier::ImportNotifier | ( | IONotifier const & | 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.
in_that | The source IONotifier to copy. |
Stream::ImportNotifier::ImportNotifier | ( | ImportNotifier && | in_that | ) |
The move constructor creates an ImportNotifier by transferring the underlying impl of the rvalue reference to this ImportNotifier thereby avoiding a copy and allocation.
in_that | An rvalue reference to an ImportNotifier to take the impl from. |
void Stream::ImportNotifier::Assign | ( | ImportNotifier const & | in_that | ) |
Associate this ImportNotifier with the same file import as the source ImportNotifier.
in_that | The source ImportNotifier for the assignment. |
ImportResultsKit Stream::ImportNotifier::GetResults | ( | ) | const |
Get the ImportResultsKit for the file import. Throws an IOException if the import is not complete or was not successful.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from IONotifier.
ImportNotifier& Stream::ImportNotifier::operator= | ( | ImportNotifier && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ImportNotifier thereby avoiding a copy.
in_that | An rvalue reference to an ImportNotifier to take the impl from. |
ImportNotifier& Stream::ImportNotifier::operator= | ( | ImportNotifier const & | in_that | ) |
Associate this ImportNotifier with the same file import as the source ImportNotifier.
in_that | The source ImportNotifier for the assignment. |