imt::base::dff::runtime::EventData Class Reference

Event data structure base. More...

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

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

Public Member Functions
	EventData ()=default
	Constructor.
virtual	~EventData ()=default
	Destructor.
virtual uint8_t *	getData ()=0
	get a pointer to the data
virtual uint8_t const *	getData () const =0
	get a pointer to the data
virtual size_t	getCapacity () const =0
	get data size
void	setDataSize (size_t const dataSize)
	set the data size
size_t	getDataSize () const
	get the current data size
void	setReceiveHandle (RuntimeCore::CoreHandle const receiverHandle)
	set receive handle
RuntimeCore::CoreHandle	getReceiveHandle () const
	get receive handle
void	setProtocolIdentifier (uint16_t const protocolIdentifier)
	set protocol identifier
uint16_t	getProtocolIdentifier () const
	get protocol identifier

Detailed Description

Event data structure base.

Todo:

rename to EventDataAbs.

Definition at line 56 of file EventData.h.

Constructor & Destructor Documentation

EventData()

imt::base::dff::runtime::EventData::EventData ( )

default

Constructor.

~EventData()

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

virtualdefault

Destructor.

Member Function Documentation

getCapacity()

virtual size_t imt::base::dff::runtime::EventData::getCapacity ( ) const

pure virtual

get data size

Returns

size of data in bytes

Implemented in imt::base::dff::runtime::EventDataNormal.

getData() [1/2]

virtual uint8_t const * imt::base::dff::runtime::EventData::getData ( ) const

pure virtual

get a pointer to the data

Returns

pointer to the data

Implemented in imt::base::dff::runtime::EventDataNormal.

getData() [2/2]

virtual uint8_t * imt::base::dff::runtime::EventData::getData ( )

pure virtual

get a pointer to the data

Returns

pointer to the data

Implemented in imt::base::dff::runtime::EventDataNormal.

getDataSize()

size_t imt::base::dff::runtime::EventData::getDataSize ( ) const

inline

get the current data size

Returns

data size in bytes

Definition at line 104 of file EventData.h.

getProtocolIdentifier()

uint16_t imt::base::dff::runtime::EventData::getProtocolIdentifier ( ) const

inline

get protocol identifier

Returns

the protocol identifier

Definition at line 136 of file EventData.h.

getReceiveHandle()

RuntimeCore::CoreHandle imt::base::dff::runtime::EventData::getReceiveHandle ( ) const

inline

get receive handle

Returns

receive handle

Definition at line 120 of file EventData.h.

setDataSize()

void imt::base::dff::runtime::EventData::setDataSize ( size_t const  dataSize )

inline

set the data size

This method shall be called if the size of the data has been changed.

Parameters

dataSize

of data in bytes

Definition at line 95 of file EventData.h.

setProtocolIdentifier()

void imt::base::dff::runtime::EventData::setProtocolIdentifier ( uint16_t const  protocolIdentifier )

inline

set protocol identifier

Parameters

protocolIdentifier

id to set

Definition at line 128 of file EventData.h.

setReceiveHandle()

void imt::base::dff::runtime::EventData::setReceiveHandle ( RuntimeCore::CoreHandle const  receiverHandle )

inline

set receive handle

Parameters

receiverHandle

handle to set

Definition at line 112 of file EventData.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/EventData.h