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

Event data structure base. More...

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

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

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

Detailed Description

Event data structure base.

Constructor & Destructor Documentation

EventData()

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

inline

constructor

Parameters

pData	data to stored on the EventData
size	of data pointed by pData in bytes

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 const uint8_t* 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

getProtocolIdentifier()

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

inline

get protocol identifier

Returns

the protocol identifier

getReceiveHandle()

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

inline

get receive handle

Returns

receive handle

setDataSize()

void imt::base::dff::runtime::EventData::setDataSize ( const size_t  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

setProtocolIdentifier()

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

inline

set protocol identifier

Parameters

protocolIdentifier

id to set

setReceiveHandle()

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

inline

set receive handle

Parameters

receiverHandle

handle to set

---

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

• D:/_Work/10/s/Imt.Base/Imt.Base.Dff.Runtime/EventData.h