DdtEncDecBiDim Class Reference

#include <ddtEncDecBiDim.hpp>

Inheritance diagram for DdtEncDecBiDim:

Public Member Functions
	DdtEncDecBiDim ()
void	decode (int length, std::vector< uint8_t > metaData)
void	encode (uint32_t bytes_per_pixel, bool complete_flag, uint32_t number_pixels_x, uint32_t number_pixels_y, bool byte_order_little_endian, int32_t binning_factor_x, int32_t binning_factor_y, bool last_segment, uint32_t data_type, uint32_t first_pixel_x, uint32_t first_pixel_y, uint32_t number_chunks_x, uint32_t number_chunks_y, uint32_t image_id)
	~DdtEncDecBiDim ()
std::vector< uint8_t >	getMetaData ()
std::string	getUtc_timestamp ()
uint32_t	getBytes_per_pixel ()
bool	getComplete_flag ()
uint32_t	getNumber_pixels_x ()
uint32_t	getNumber_pixels_y ()
bool	getByte_order_little_endian ()
int32_t	getBinning_factor_x ()
int32_t	getBinning_factor_y ()
bool	getLast_segment ()
uint32_t	getData_type ()
uint32_t	getFirst_pixel_x ()
uint32_t	getFirst_pixel_y ()
uint32_t	getNumber_chunks_x ()
uint32_t	getNumber_chunks_y ()
uint32_t	getImage_id ()
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::MetaDataBiDim	metadataBiDim
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 bi-dimensional data samples

This class holds the meta data for bi-dimensional 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

DdtEncDecBiDim()

DdtEncDecBiDim::DdtEncDecBiDim ( )

explicit

Constructor

~DdtEncDecBiDim()

DdtEncDecBiDim::~DdtEncDecBiDim ( )

default

Destructor

Member Function Documentation

decode()

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

Decode a meta data block into the bi-dimensional meta data

encode()

void DdtEncDecBiDim::encode	(	uint32_t	bytes_per_pixel,
		bool	complete_flag,
		uint32_t	number_pixels_x,
		uint32_t	number_pixels_y,
		bool	byte_order_little_endian,
		int32_t	binning_factor_x,
		int32_t	binning_factor_y,
		bool	last_segment,
		uint32_t	data_type,
		uint32_t	first_pixel_x,
		uint32_t	first_pixel_y,
		uint32_t	number_chunks_x,
		uint32_t	number_chunks_y,
		uint32_t	image_id
	)

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.

getBinning_factor_x()

int32_t DdtEncDecBiDim::getBinning_factor_x

(

)

Return the binnning_factor_x member.

getBinning_factor_y()

int32_t DdtEncDecBiDim::getBinning_factor_y

(

)

Return the binning_factor_y member.

getByte_order_little_endian()

bool DdtEncDecBiDim::getByte_order_little_endian

(

)

Return the byte_order_little_endian member.

getBytes_per_pixel()

uint32_t DdtEncDecBiDim::getBytes_per_pixel

(

)

Return the bytes_per_pixel member.

getComplete_flag()

bool DdtEncDecBiDim::getComplete_flag

(

)

Return the complete_flag member.

getData_type()

uint32_t DdtEncDecBiDim::getData_type

(

)

Return the data_type member.

getFirst_pixel_x()

uint32_t DdtEncDecBiDim::getFirst_pixel_x

(

)

Return the first_pixel_x member.

getFirst_pixel_y()

uint32_t DdtEncDecBiDim::getFirst_pixel_y

(

)

Return the first_pixel_y member.

getImage_id()

uint32_t DdtEncDecBiDim::getImage_id

(

)

Return the image_id member.

getLast_segment()

bool DdtEncDecBiDim::getLast_segment

(

)

Return the last_segment member.

getMetaData()

std::vector< uint8_t > DdtEncDecBiDim::getMetaData

(

)

Return the meta data as vector of bytes.

getNumber_chunks_x()

uint32_t DdtEncDecBiDim::getNumber_chunks_x

(

)

Return the number_chunks_x member.

getNumber_chunks_y()

uint32_t DdtEncDecBiDim::getNumber_chunks_y

(

)

Return the number_chunks_x member.

getNumber_pixels_x()

uint32_t DdtEncDecBiDim::getNumber_pixels_x

(

)

Return the number_pixels_x member.

getNumber_pixels_y()

uint32_t DdtEncDecBiDim::getNumber_pixels_y

(

)

Return the number_pixels_y member.

getUtc_timestamp()

std::string DdtEncDecBiDim::getUtc_timestamp

(

)

Return the utc_timestamp member.

Member Data Documentation

metadataBiDim

ddt::MetaDataBiDim DdtEncDecBiDim::metadataBiDim

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/ddtEncDecBiDim.hpp
• datatransfer/datatransferlib/src/ddtEncDecBiDim.cpp