Dataflow Runtime API  4.0.1.0
Public Member Functions | List of all members
imt::base::dff::runtime::EventData Class Referenceabstract

Event data structure base. More...

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

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

Public Member Functions

 EventData ()
 constructor More...
 
virtual uint8_tgetData ()=0
 get a pointer to the data More...
 
virtual uint8_t const * getData () const =0
 get a pointer to the data More...
 
virtual size_t getCapacity () const =0
 get data size More...
 
void setDataSize (size_t const dataSize)
 set the data size More...
 
size_t getDataSize () const
 get the current data size More...
 
void setReceiveHandle (RuntimeCore::CoreHandle const receiverHandle)
 set receive handle More...
 
RuntimeCore::CoreHandle getReceiveHandle () const
 get receive handle More...
 
void setProtocolIdentifier (uint16_t const 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

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

◆ 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 ( size_t const  dataSize)
inline

set the data size

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

Parameters
dataSizeof data in bytes

◆ setProtocolIdentifier()

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

set protocol identifier

Parameters
protocolIdentifierid to set

◆ setReceiveHandle()

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

set receive handle

Parameters
receiverHandlehandle to set

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