HPS::TimerTickEvent Class Reference

#include <hps.h>

Inheritance diagram for HPS::TimerTickEvent:

Public Member Functions
Event *	Clone () const
virtual bool	Drop (Event const *in_that_event) const
virtual intptr_t	Freshen () const
	TimerTickEvent ()
	TimerTickEvent (Event const &in_event)
Public Member Functions inherited from HPS::Event
	Event (intptr_t in_channel=0)
intptr_t	GetChannel () const
intptr_t	GetClassID () const
Time	GetTimeStamp () const
bool	IsConsumable () const

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 TimerTickEvent class is the event that will be triggered for each timer tick.

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_event

The Event Object to be converted.

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_event

Event 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.

---

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

• include/hps.h