HPS::Exchange::ReloadNotifier Class Reference

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::ReloadNotifier:

Public Member Functions
void	Assign (ReloadNotifier const &in_that)
HPS::Type	ObjectType () const
ReloadNotifier &	operator= (ReloadNotifier &&in_that)
ReloadNotifier &	operator= (ReloadNotifier const &in_that)
	ReloadNotifier ()
	ReloadNotifier (ReloadNotifier const &in_that)
	ReloadNotifier (IONotifier const &in_that)
	ReloadNotifier (ReloadNotifier &&in_that)
Public Member Functions inherited from HPS::IONotifier
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 ()
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)
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::ExchangeReloadNotifier
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 ReloadNotifier class is a smart-pointer that is tied to a Component::Reload or a CADModel::Reload. It is used to interact with an ongoing reload.

Constructor & Destructor Documentation

ReloadNotifier() [1/4]

HPS::Exchange::ReloadNotifier::ReloadNotifier

(

)

The default constructor creates an ReloadNotifier object which is not tied to any component reload.

ReloadNotifier() [2/4]

HPS::Exchange::ReloadNotifier::ReloadNotifier

(

ReloadNotifier const &

in_that

)

The copy constructor creates a new ReloadNotifier object that is associated with the same component reload as the source ReloadNotifier.

Parameters

in_that

The source ReloadNotifier to copy.

ReloadNotifier() [3/4]

HPS::Exchange::ReloadNotifier::ReloadNotifier

(

IONotifier const &

in_that

)

The conversion constructor creates a new derived ReloadNotifier 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 ReloadNotifier will be invalid.

Parameters

in_that

The source IONotifier to copy.

ReloadNotifier() [4/4]

HPS::Exchange::ReloadNotifier::ReloadNotifier

(

ReloadNotifier &&

in_that

)

The move constructor creates an ReloadNotifier by transferring the underlying object of the rvalue reference to this ReloadNotifier thereby avoiding a copy and allocation.

Parameters

in_that

An rvalue reference to an ReloadNotifier to take the underlying object from.

Member Function Documentation

Assign()

void HPS::Exchange::ReloadNotifier::Assign

(

ReloadNotifier const &

in_that

)

Associate this ReloadNotifier with the same component reload as the source ReloadNotifier.

Parameters

in_that

The source ReloadNotifier for the assignment.

ObjectType()

HPS::Type HPS::Exchange::ReloadNotifier::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]

ReloadNotifier& HPS::Exchange::ReloadNotifier::operator=

(

ReloadNotifier &&

in_that

)

The move assignment operator transfers the underlying object of the rvalue reference to this ReloadNotifier thereby avoiding a copy.

Parameters

in_that

An rvalue reference to an ReloadNotifier to take the underlying object from.

Returns

A reference to this ReloadNotifier.

operator=() [2/2]

ReloadNotifier& HPS::Exchange::ReloadNotifier::operator=

(

ReloadNotifier const &

in_that

)

Associate this ReloadNotifier with the same component reload as the source ReloadNotifier.

Parameters

in_that

The source ReloadNotifier for the assignment.

Returns

A reference to this ReloadNotifier.

---

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

• include/sprk_exchange.h