imt::base::dff::runtime::RuntimeTimerEvent Class Reference

Event arguments which are passed when a timer is fired. More...

#include <Imt.Base.Dff.Runtime/RuntimeTimerEvent.h>

Inheritance diagram for imt::base::dff::runtime::RuntimeTimerEvent:

Public Member Functions
	RuntimeTimerEvent ()
	Default Constructor. More...
	RuntimeTimerEvent (::imt::base::core::serialization::Deserializer &deserializer)
	Constructor from deserializer. More...
virtual	~RuntimeTimerEvent ()
	Destructor. More...
virtual uint16_t	getEventIdentifier () const
virtual size_t	getEventSize () const
virtual void	deserialize (::imt::base::core::serialization::Deserializer &deserializer)
virtual void	serialize (::imt::base::core::serialization::Serializer &serializer) const
void	setTimerIdentifier (RuntimeTimer::TimerHandle const timerHandle)
	Set the timer handle identifier which can be serialized. More...
RuntimeTimer::TimerHandle	getTimerIdentifier () const
	Get the timer handle identifier which has been deserialized. More...
bool	isEqual (RuntimeTimer::TimerHandle const timerHandle) const
	Determines whether the passed timerHandle is equal to the current event timer handle. More...
Public Member Functions inherited from imt::base::dff::runtime::EventIfc
virtual	~EventIfc ()
	Destructor. More...
Public Member Functions inherited from imt::base::core::serialization::SerializableIfc
virtual	~SerializableIfc ()
	Destructor. More...
virtual void	deserialize (Deserializer &deserializer)=0
	Deserialize this object from the given deserializer. More...
virtual void	serialize (Serializer &serializer) const =0
	Serialize this object into the given serializer. More...

Static Public Attributes
static uint32_t const	MAX_SERIALIZED_SIZE_BYTES = sizeof(RuntimeTimer::TimerHandle)
	Maximum serialized data bytes. More...

Detailed Description

Event arguments which are passed when a timer is fired.

Protocol Identifier = RuntimeProtocolIdentifiers::TIMER

Constructor & Destructor Documentation

RuntimeTimerEvent() [1/2]

imt::base::dff::runtime::RuntimeTimerEvent::RuntimeTimerEvent ( )

explicit

Default Constructor.

RuntimeTimerEvent() [2/2]

imt::base::dff::runtime::RuntimeTimerEvent::RuntimeTimerEvent ( ::imt::base::core::serialization::Deserializer &  deserializer )

explicit

Constructor from deserializer.

Parameters

deserializer

Deserializer.

~RuntimeTimerEvent()

virtual imt::base::dff::runtime::RuntimeTimerEvent::~RuntimeTimerEvent ( )

virtual

Destructor.

Member Function Documentation

deserialize()

virtual void imt::base::dff::runtime::RuntimeTimerEvent::deserialize ( ::imt::base::core::serialization::Deserializer &  deserializer )

virtual

See also

SerializableIfc

getEventIdentifier()

virtual uint16_t imt::base::dff::runtime::RuntimeTimerEvent::getEventIdentifier ( ) const

virtual

See also

EventIfc

Implements imt::base::dff::runtime::EventIfc.

getEventSize()

virtual size_t imt::base::dff::runtime::RuntimeTimerEvent::getEventSize ( ) const

virtual

See also

EventIfc

Implements imt::base::dff::runtime::EventIfc.

getTimerIdentifier()

RuntimeTimer::TimerHandle imt::base::dff::runtime::RuntimeTimerEvent::getTimerIdentifier

(

)

const

Get the timer handle identifier which has been deserialized.

Returns

Timer handle.

isEqual()

bool imt::base::dff::runtime::RuntimeTimerEvent::isEqual

(

RuntimeTimer::TimerHandle const

timerHandle

)

const

Determines whether the passed timerHandle is equal to the current event timer handle.

Parameters

timerHandle

The timer handle to compare with the current event timer handle.

Returns

True if the specified timer handle is equal to the event timer handle, false otherwise.

serialize()

virtual void imt::base::dff::runtime::RuntimeTimerEvent::serialize ( ::imt::base::core::serialization::Serializer &  serializer ) const

virtual

See also

SerializableIfc

setTimerIdentifier()

void imt::base::dff::runtime::RuntimeTimerEvent::setTimerIdentifier

(

RuntimeTimer::TimerHandle const

timerHandle

)

Set the timer handle identifier which can be serialized.

Parameters

timerHandle

Timer handle to set.

Member Data Documentation

MAX_SERIALIZED_SIZE_BYTES

uint32_t const imt::base::dff::runtime::RuntimeTimerEvent::MAX_SERIALIZED_SIZE_BYTES = sizeof(RuntimeTimer::TimerHandle)

static

Maximum serialized data bytes.

---

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

• C:/src/imt/Imt.Base-cpp/Imt.Base/Imt.Base.Dff.Runtime/RuntimeTimerEvent.h