HPS::UpdateNotifier Class Reference

#include <hps.h>

Inheritance diagram for HPS::UpdateNotifier:
HPS::Object

Public Member Functions

void Assign (UpdateNotifier const &in_that)
 
UpdateNotifier const & Cancel () const
 
HPS::Type ObjectType () const
 
UpdateNotifieroperator= (UpdateNotifier &&in_that)
 
UpdateNotifieroperator= (UpdateNotifier const &in_that)
 
Window::UpdateStatus Status () const
 
 UpdateNotifier (UpdateNotifier const &in_that)
 
 UpdateNotifier (UpdateNotifier &&in_that)
 
UpdateNotifier const & Wait () const
 
- 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::UpdateNotifier
 
- 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 UpdateNotifier class is a smart pointer that is associated with a window update. It is a special type of control that is used for synchronizing with a window update status.

Constructor & Destructor Documentation

◆ UpdateNotifier()

HPS::UpdateNotifier::UpdateNotifier ( UpdateNotifier &&  in_that)

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

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

Member Function Documentation

◆ Assign()

void HPS::UpdateNotifier::Assign ( UpdateNotifier const &  in_that)

Share the underlying smart-pointer of the UpdateNotifier source.

Parameters
in_thatThe UpdateNotifier source of the assignment.

◆ Cancel()

UpdateNotifier const& HPS::UpdateNotifier::Cancel ( ) const

Requests to cancel this Notifier's Update operation. The cancel operation returns without waiting for the Update to complete. To ensure that the Update is complete, you must call Wait().

Returns
A reference to this UpdateNotifier.

◆ ObjectType()

HPS::Type HPS::UpdateNotifier::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::Object.

◆ operator=() [1/2]

UpdateNotifier& HPS::UpdateNotifier::operator= ( UpdateNotifier &&  in_that)

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

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

◆ operator=() [2/2]

UpdateNotifier& HPS::UpdateNotifier::operator= ( UpdateNotifier const &  in_that)

Share the underlying smart-pointer of the UpdateNotifier source.

Parameters
in_thatThe UpdateNotifier source of the assignment.
Returns
A reference to this UpdateNotifier.

◆ Status()

Window::UpdateStatus HPS::UpdateNotifier::Status ( ) const

Returns the HPS::Window::UpdateStatus for the Update represented by this UpdateNotifier.

◆ Wait()

UpdateNotifier const& HPS::UpdateNotifier::Wait ( ) const

Wait for this Notifier to complete its Update.

Returns
A reference to this UpdateNotifier.

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