Dataflow Runtime API  2.7.4.0
Public Member Functions | Static Public Attributes | List of all members
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:
imt::base::core::serialization::SerializableIfc

Public Member Functions

 RuntimeTimerEvent (void)
 Default Constructor.
 
 RuntimeTimerEvent (imt::base::core::serialization::Deserializer &deserializer)
 Constructor from deserializer. More...
 
virtual ~RuntimeTimerEvent (void)
 Destructor.
 
virtual void deserialize (imt::base::core::serialization::Deserializer &deserializer)
 
virtual void serialize (imt::base::core::serialization::Serializer &serializer) const
 
void setTimerIdentifier (const RuntimeTimer::TimerHandle timerHandle)
 Set the timer handle identifier which can be serialized. More...
 
RuntimeTimer::TimerHandle getTimerIdentifier (void) const
 Get the timer handle identifier which has been deserialized. More...
 
bool isEqual (const RuntimeTimer::TimerHandle timerHandle) const
 Determines whether the passed timerHandle is equal to the current event timer handle. More...
 
- Public Member Functions inherited from imt::base::core::serialization::SerializableIfc
virtual ~SerializableIfc (void)
 Destructor.
 

Static Public Attributes

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

Detailed Description

Event arguments which are passed when a timer is fired.

Protocol Identifier = RuntimeProtocolIdentifiers::TIMER

Constructor & Destructor Documentation

◆ RuntimeTimerEvent()

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

Constructor from deserializer.

Parameters
deserializerDeserializer.

Member Function Documentation

◆ deserialize()

virtual void imt::base::dff::runtime::RuntimeTimerEvent::deserialize ( imt::base::core::serialization::Deserializer deserializer)
virtual
See also
SerializableIfc

Implements imt::base::core::serialization::SerializableIfc.

◆ getTimerIdentifier()

RuntimeTimer::TimerHandle imt::base::dff::runtime::RuntimeTimerEvent::getTimerIdentifier ( void  ) const

Get the timer handle identifier which has been deserialized.

Returns
Timer handle.

◆ isEqual()

bool imt::base::dff::runtime::RuntimeTimerEvent::isEqual ( const RuntimeTimer::TimerHandle  timerHandle) const

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

Parameters
timerHandleThe 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

Implements imt::base::core::serialization::SerializableIfc.

◆ setTimerIdentifier()

void imt::base::dff::runtime::RuntimeTimerEvent::setTimerIdentifier ( const RuntimeTimer::TimerHandle  timerHandle)

Set the timer handle identifier which can be serialized.

Parameters
timerHandleTimer handle to set.

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