HPS::Stream::ImportNotifier Class Reference

#include <hps.h>

Inheritance diagram for HPS::Stream::ImportNotifier:
HPS::IONotifier HPS::Object

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)
 
HPS::Type ObjectType () const
 
ImportNotifieroperator= (ImportNotifier &&in_that)
 
ImportNotifieroperator= (ImportNotifier 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::StreamImportNotifier
 
- 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 ImportNotifier class is a smart-pointer that is associated with an asynchronous file import. It is used to interact with an ongoing import or get the results from a completed import.

Constructor & Destructor Documentation

◆ ImportNotifier() [1/4]

HPS::Stream::ImportNotifier::ImportNotifier ( )

The default constructor creates an ImportNotifier object which is not associated with any file import.

◆ ImportNotifier() [2/4]

HPS::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.

Parameters
in_thatThe source ImportNotifier to copy.

◆ ImportNotifier() [3/4]

HPS::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.

Parameters
in_thatThe source IONotifier to copy.

◆ ImportNotifier() [4/4]

HPS::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.

Parameters
in_thatAn rvalue reference to an ImportNotifier to take the impl from.

Member Function Documentation

◆ Assign()

void HPS::Stream::ImportNotifier::Assign ( ImportNotifier const &  in_that)

Associate this ImportNotifier with the same file import as the source ImportNotifier.

Parameters
in_thatThe source ImportNotifier for the assignment.

◆ GetResults()

ImportResultsKit HPS::Stream::ImportNotifier::GetResults ( ) const

Get the ImportResultsKit for the file import. Throws an IOException if the import is not complete or was not successful.

Returns
The ImportResultsKit for a successful file import.

◆ ObjectType()

HPS::Type HPS::Stream::ImportNotifier::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]

ImportNotifier& HPS::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.

Parameters
in_thatAn rvalue reference to an ImportNotifier to take the impl from.
Returns
A reference to this ImportNotfier.

◆ operator=() [2/2]

ImportNotifier& HPS::Stream::ImportNotifier::operator= ( ImportNotifier const &  in_that)

Associate this ImportNotifier with the same file import as the source ImportNotifier.

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

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