UpdateNotifier
-
class HPS::UpdateNotifier : public HPS::Object
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.
Public Functions
-
void Assign(UpdateNotifier const &in_that)
Share the underlying smart-pointer of the UpdateNotifier source.
- Parameters
in_that – The UpdateNotifier source of the assignment.
-
UpdateNotifier const &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.
-
inline virtual HPS::Type ObjectType() const
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.
-
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_that – An rvalue reference to an UpdateNotifier to take the impl from.
- Returns
A reference to this UpdateNotifier.
-
UpdateNotifier &operator=(UpdateNotifier const &in_that)
Share the underlying smart-pointer of the UpdateNotifier source.
- Parameters
in_that – The UpdateNotifier source of the assignment.
- Returns
A reference to this UpdateNotifier.
-
Window::UpdateStatus Status() const
Returns the HPS::Window::UpdateStatus for the Update represented by this UpdateNotifier.
-
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_that – An rvalue reference to an UpdateNotifier to take the impl from.
-
UpdateNotifier(UpdateNotifier const &in_that)
-
UpdateNotifier const &Wait() const
Wait for this Notifier to complete its Update.
- Returns
A reference to this UpdateNotifier.
-
virtual ~UpdateNotifier()
Public Static Attributes
-
static const HPS::Type staticType = HPS::Type::UpdateNotifier
-
void Assign(UpdateNotifier const &in_that)
