HPS::UpdateCompletedEvent Class Reference

#include <hps.h>

Inheritance diagram for HPS::UpdateCompletedEvent:

Public Member Functions

EventClone () const
 UpdateCompletedEvent ()
 UpdateCompletedEvent (Time in_update_time, Window::UpdateStatus in_update_status)
 UpdateCompletedEvent (Event const &in_event)
- Public Member Functions inherited from HPS::Event
virtual bool Drop (Event const *in_that_event) const
 Event (intptr_t in_channel=0)
virtual intptr_t Freshen () const
intptr_t GetChannel () const
intptr_t GetClassID () const
Time GetTimeStamp () const
bool IsConsumable () const

Public Attributes

Window::UpdateStatus update_status
Time update_time

Additional Inherited Members

- Public Types inherited from HPS::Event
enum  Status : uint32_t { Status::InProgress, Status::Completed, Status::Failed }
- Static Public Member Functions inherited from HPS::Event
static void operator delete (void *in_ptr, size_t in_size) throw ()
static void * operator new (size_t in_size)
- Protected Attributes inherited from HPS::Event
intptr_t channel
bool consumable

Detailed Description

The UpdateCompletedEvent class is the event that is generated when an update is completed Note: Updates happen on a per-WindowKey basis, therefore, EventHandler objects which handle UpdateCompletedEvents need to be subscribed to the EventDispatcher of the WindowKey whose update needs to be monitored. Example: myWindow.GetEventDspatcher().Subscribe(*my_handler, HPS::Object::ClassID<HPS::UpdateCompletedEvent>());

Constructor & Destructor Documentation

◆ UpdateCompletedEvent() [1/3]

HPS::UpdateCompletedEvent::UpdateCompletedEvent ( )

The default constructor creates a UpdateCompletedEvent.

◆ UpdateCompletedEvent() [2/3]

HPS::UpdateCompletedEvent::UpdateCompletedEvent ( Time  in_update_time,
Window::UpdateStatus  in_update_status 

The constructor creates a UpdateCompletedEvent.

◆ UpdateCompletedEvent() [3/3]

HPS::UpdateCompletedEvent::UpdateCompletedEvent ( Event const &  in_event)

This constructor converts an Event Object to an UpdateCompletedEvent object.

in_eventThe Event Object to be converted.

Member Function Documentation

◆ Clone()

Event* HPS::UpdateCompletedEvent::Clone ( ) const

Allocates and returns a copy of this UpdateCompletedEvent.

A copy of this UpdateCompletedEvent.

Implements HPS::Event.

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