#include <hps.h>
Public Member Functions | |
void | Assign (IONotifier const &in_that) |
void | Cancel () |
IONotifier () | |
IONotifier (IONotifier const &in_that) | |
IONotifier (IONotifier &&in_that) | |
HPS::Type | ObjectType () const |
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 (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 () |
HPS::Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The IONotifier 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.
HPS::IONotifier::IONotifier | ( | ) |
The default constructor creates an IONotifier object which is not tied to any file import.
HPS::IONotifier::IONotifier | ( | IONotifier const & | in_that | ) |
The copy constructor creates a new IONotifier object that is associated with the same file import as the source IONotifier.
in_that | The source IONotifier to copy. |
HPS::IONotifier::IONotifier | ( | IONotifier && | in_that | ) |
The move constructor creates an IONotifier by transferring the underlying impl of the rvalue reference to this IONotifier thereby avoiding a copy and allocation.
in_that | An rvalue reference to an IONotifier to take the impl from. |
void HPS::IONotifier::Assign | ( | IONotifier const & | in_that | ) |
Associate this IONotifier with the same file import as the source IONotifier.
in_that | The source IONotifier for the assignment. |
void HPS::IONotifier::Cancel | ( | ) |
Cancels the import if it is still in progress. There may be some delay between when the cancel request is made and when the import stops and any associated data is deleted as the importer checks for a cancel request periodically during import.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Object.
Reimplemented in HPS::STL::ImportNotifier, HPS::OBJ::ImportNotifier, HPS::Stream::ExportNotifier, HPS::Stream::ImportNotifier, HPS::Exchange::ReloadNotifier, HPS::Exchange::ExportNotifier, HPS::Exchange::TranslationNotifier, and HPS::Exchange::ImportNotifier.
IONotifier& HPS::IONotifier::operator= | ( | IONotifier && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this IONotifier thereby avoiding a copy.
in_that | An rvalue reference to an IONotifier to take the impl from. |
IONotifier& HPS::IONotifier::operator= | ( | IONotifier const & | in_that | ) |
Associate this IONotifier with the same file import as the source IONotifier.
in_that | The source IONotifier for the assignment. |
IOResult HPS::IONotifier::Status | ( | ) | const |
Query the status of the file import this notifier is tied to.
IOResult HPS::IONotifier::Status | ( | float & | out_percent_complete | ) | const |
Query the status of the file import this notifier is tied to and its percentage complete.
out_percent_complete | Float in the range [0,1] indicating the current percentage complete. |
void HPS::IONotifier::Wait | ( | ) |
Cause this thread to sleep until the file import this notifier is tied to has been handled.