TimerTickEvent

class HPS::TimerTickEvent : public HPS::Event

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

Public Functions

inline virtual Event *Clone() const

Allocates and returns a copy of this TimerEvent.

Returns

A copy of this TimerEvent.

inline virtual bool Drop(Event const *in_that_event) const

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.

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

Returns

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

inline TimerTickEvent()

The default constructor creates a TimerTickEvent object.

inline TimerTickEvent(Event const &in_event)

This constructor converts an Event Object to a TimerTickEvent object.

Parameters

in_event – The Event Object to be converted.

~TimerTickEvent()