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

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

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

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

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

Static Public Attributes
static constexpr uint32_t	MAX_SERIALIZED_SIZE_BYTES {sizeof(RuntimeTimer::TimerHandle)}
	Maximum serialized data bytes.

Additional Inherited Members
Protected Member Functions inherited from imt::base::dff::runtime::EventIfc
	EventIfc () noexcept=default
	EventIfc (EventIfc const &) noexcept=default
	EventIfc (EventIfc &&) noexcept=default
	~EventIfc () noexcept=default
EventIfc &	operator= (EventIfc const &) &noexcept=default
EventIfc &	operator= (EventIfc &&) &noexcept=default
Protected Member Functions inherited from imt::base::core::serialization::SerializableIfc
	SerializableIfc () noexcept=default
	SerializableIfc (SerializableIfc const &) noexcept=default
	SerializableIfc (SerializableIfc &&) noexcept=default
	~SerializableIfc () noexcept=default
SerializableIfc &	operator= (SerializableIfc const &) &noexcept=default
SerializableIfc &	operator= (SerializableIfc &&) &noexcept=default

Detailed Description

Event arguments which are passed when a timer is fired.

Protocol Identifier = RuntimeProtocolIdentifiers::TIMER

Definition at line 54 of file RuntimeTimerEvent.h.

Constructor & Destructor Documentation

RuntimeTimerEvent() [1/2]

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

default

Default Constructor.

RuntimeTimerEvent() [2/2]

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

explicit

Constructor from deserialize.

Parameters

buffer

Deserializer.

Member Function Documentation

deserialize()

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

final

See also

SerializableIfc

getEventIdentifier()

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

finalvirtual

See also

EventIfc

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

getEventSize()

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

finalvirtual

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()

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

final

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

constexpr uint32_t imt::base::dff::runtime::RuntimeTimerEvent::MAX_SERIALIZED_SIZE_BYTES {sizeof(RuntimeTimer::TimerHandle)}

staticconstexpr

Maximum serialized data bytes.

Definition at line 61 of file RuntimeTimerEvent.h.

---

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

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