DdtEncDecMultiDim Class Reference

#include <ddtEncDecMultiDim.hpp>

Inheritance diagram for DdtEncDecMultiDim:

Public Member Functions
	DdtEncDecMultiDim ()
void	decode (int length, std::vector< uint8_t > metaData)
void	encode (uint32_t bytes_per_value, uint32_t number_dimensions, std::string array_dimensions, bool byte_order_little_endian, bool last_segment, std::string description, uint32_t data_type)
	~DdtEncDecMultiDim ()
std::vector< uint8_t >	getMetaData ()
uint32_t	getBytes_per_value ()
uint32_t	getNumber_dimensions ()
std::string	getArray_dimensions ()
bool	getByte_order_little_endian ()
std::string	getUtc_timestamp ()
bool	getLast_segment ()
std::string	getDescription ()
uint32_t	getData_type ()
Public Member Functions inherited from DdtEncDec
	DdtEncDec ()
virtual	~DdtEncDec ()=0
virtual void	setMetaDataLength (const int mdl)
virtual void	setTopicId (const int ti)
virtual int	getMetaDataLength ()
virtual int	getTopicId ()

Protected Attributes
ddt::MetaDataMultiDim	metadataMultiDim
Protected Attributes inherited from DdtEncDec
int	topicId
int	metaDataLength

Additional Inherited Members
Protected Member Functions inherited from DdtEncDec
std::string	getCurrentTime ()

Detailed Description

Class to encode / decode multi-dimensional array data samples

This class holds the meta data for multi-dimensional array data samples. Given a block of meta data as available after transfer over network, it will decode it into the meta-data information. The encode function takes the meta-data information and forms a meta data block that can be used for transfer.

Constructor & Destructor Documentation

DdtEncDecMultiDim()

DdtEncDecMultiDim::DdtEncDecMultiDim ( )

explicit

Constructor

~DdtEncDecMultiDim()

DdtEncDecMultiDim::~DdtEncDecMultiDim ( )

default

Destructor

Member Function Documentation

decode()

void DdtEncDecMultiDim::decode	(	int	length,
		std::vector< uint8_t >	metaData
	)

Decode a meta data block into the multi-dimensional array meta data

encode()

void DdtEncDecMultiDim::encode	(	uint32_t	bytes_per_value,
		uint32_t	number_dimensions,
		std::string	array_dimensions,
		bool	byte_order_little_endian,
		bool	last_segment,
		std::string	description,
		uint32_t	data_type
	)

Encode the provided meta data information into a meta data block. Note that the UTC time stamp that is part of the meta data will be set within the encode function.

getArray_dimensions()

std::string DdtEncDecMultiDim::getArray_dimensions

(

)

Return the dimensions of the multi-dimensional array as comma-separated list.

getByte_order_little_endian()

bool DdtEncDecMultiDim::getByte_order_little_endian

(

)

Return the byte_order_little_endian member.

getBytes_per_value()

uint32_t DdtEncDecMultiDim::getBytes_per_value

(

)

Return the bytes_per_pixel member.

getData_type()

uint32_t DdtEncDecMultiDim::getData_type

(

)

Return the data_type member.

getDescription()

std::string DdtEncDecMultiDim::getDescription

(

)

Return the description member.

getLast_segment()

bool DdtEncDecMultiDim::getLast_segment

(

)

Return the last_segment member.

getMetaData()

std::vector< uint8_t > DdtEncDecMultiDim::getMetaData

(

)

Return the meta data as vector of bytes.

getNumber_dimensions()

uint32_t DdtEncDecMultiDim::getNumber_dimensions

(

)

Return the number_dimensions member.

getUtc_timestamp()

std::string DdtEncDecMultiDim::getUtc_timestamp

(

)

Return the utc_timestamp member.

Member Data Documentation

metadataMultiDim

ddt::MetaDataMultiDim DdtEncDecMultiDim::metadataMultiDim

protected

Meta data structure to hold the meta data and to provide methods to parse the data from a string and to provide the meta data as vector of bytes

---

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

• datatransfer/datatransferlib/src/include/ddt/ddtEncDecMultiDim.hpp
• datatransfer/datatransferlib/src/ddtEncDecMultiDim.cpp