Hoops Visualize HPS  version 2018-SP2
Hoops Visualize HPS 3D Rendering Engine
Looking for a senior C++ dev?
I'm looking for work. Hire me!
HPS::TimerTickEvent Class Reference

The TimerTickEvent class is the event that will be triggered for each timer tick. More...

#include <hps.h>

Inheritance diagram for HPS::TimerTickEvent:
Collaboration diagram for HPS::TimerTickEvent:

Public Types

enum  Status : uint32_t {
  Status::InProgress,
  Status::Completed,
  Status::Failed
}
 Event Status - returned from a notifier to give the status of the event. More...
 

Public Member Functions

 TimerTickEvent ()
 The default constructor creates a TimerTickEvent object. More...
 
 TimerTickEvent (Event const &in_event)
 This constructor converts an Event Object to a TimerTickEvent object. More...
 
 ~TimerTickEvent ()
 
EventClone () const
 Allocates and returns a copy of this TimerEvent. More...
 
virtual bool Drop (Event const *in_that_event) const
 Determines if this TimerTickEvent can be drop in favor of the following time tick event. More...
 
virtual intptr_t Freshen () const
 This optional function is used to determine if the current event can be dropped in favor of newer event of the same type if one is available. More...
 
intptr_t GetClassID () const
 Returns a unique identifier that is shared by all objects of the same class. More...
 
intptr_t GetChannel () const
 Returns the channel ID assigned to an event. More...
 
Time GetTimeStamp () const
 Returns the time an event was injected into the event queue. More...
 
bool IsConsumable () const
 Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway. More...
 

Static Public Member Functions

static void * operator new (size_t in_size)
 
static void operator delete (void *in_ptr, size_t in_size) throw ()
 

Protected Attributes

intptr_t channel
 
bool consumable
 

Detailed Description

The TimerTickEvent class is the event that will be triggered for each timer tick.

Member Enumeration Documentation

◆ Status

enum HPS::Event::Status : uint32_t
stronginherited

Event Status - returned from a notifier to give the status of the event.

Enumerator
InProgress 

Event is still in progress.

Completed 

Event has completed.

Failed 

Event failed.

Constructor & Destructor Documentation

◆ TimerTickEvent() [1/2]

HPS::TimerTickEvent::TimerTickEvent ( )
inline

The default constructor creates a TimerTickEvent object.

◆ TimerTickEvent() [2/2]

HPS::TimerTickEvent::TimerTickEvent ( Event const &  in_event)
inline

This constructor converts an Event Object to a TimerTickEvent object.

Parameters
in_eventThe Event Object to be converted.
Here is the call graph for this function:

◆ ~TimerTickEvent()

HPS::TimerTickEvent::~TimerTickEvent ( )

Member Function Documentation

◆ Clone()

Event* HPS::TimerTickEvent::Clone ( ) const
inlinevirtual

Allocates and returns a copy of this TimerEvent.

Returns
A copy of this TimerEvent.

Implements HPS::Event.

◆ Drop()

virtual bool HPS::TimerTickEvent::Drop ( Event const *  in_that_event) const
inlinevirtual

Determines if this TimerTickEvent can be drop in favor of the following time tick event.

Parameters
in_that_eventEvent to compare with this TimerTickEvent.
Returns
true if this event can be dropped, false otherwise.

Reimplemented from HPS::Event.

◆ Freshen()

virtual intptr_t HPS::TimerTickEvent::Freshen ( ) const
inlinevirtual

This optional function is used to determine if the current event can be dropped in favor of newer event of the same type if one is available.

Returns
A cookie representing the freshen category. Zero indicates a non-freshening event.

Reimplemented from HPS::Event.

◆ GetChannel()

intptr_t HPS::Event::GetChannel ( ) const
inlineinherited

Returns the channel ID assigned to an event.

Here is the caller graph for this function:

◆ GetClassID()

intptr_t HPS::Event::GetClassID ( ) const
inherited

Returns a unique identifier that is shared by all objects of the same class.

Here is the caller graph for this function:

◆ GetTimeStamp()

Time HPS::Event::GetTimeStamp ( ) const
inlineinherited

Returns the time an event was injected into the event queue.

◆ IsConsumable()

bool HPS::Event::IsConsumable ( ) const
inlineinherited

Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway.

◆ operator delete()

static void HPS::Event::operator delete ( void *  in_ptr,
size_t  in_size 
)
throw (
)
inlinestaticinherited
Here is the call graph for this function:

◆ operator new()

static void* HPS::Event::operator new ( size_t  in_size)
inlinestaticinherited
Here is the call graph for this function:

Member Data Documentation

◆ channel

intptr_t HPS::Event::channel
protectedinherited

◆ consumable

bool HPS::Event::consumable
protectedinherited

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