DdtEncDecBinaryxD Class Reference

#include <ddtEncDecBinaryxD.hpp>

Inheritance diagram for DdtEncDecBinaryxD:

Public Member Functions
	DdtEncDecBinaryxD ()
void	Decode (const int length, std::vector< uint8_t > meta_data)
void	Encode (MetaDataElementsBinaryxD const &meta_data)
	~DdtEncDecBinaryxD () override
std::vector< uint8_t >	get_meta_data () const
uint32_t	get_bytes_per_pixel () const override
uint32_t	get_number_dimensions () const override
std::string	get_utc_timestamp () const override
bool	get_complete_flag () const override
bool	get_last_segment () const override
bool	get_byte_order_little_endian () const override
uint32_t	get_data_type () const override
std::string	get_data_type_str () const override
std::string	get_description () const override
std::string	get_array_dimensions () const
std::string	get_configuration_map_name () const
std::string	get_labels () const
Public Member Functions inherited from DdtEncDec
	DdtEncDec ()
virtual	~DdtEncDec ()=0
virtual void	set_meta_data_length (const int mdl)
void	set_topic_id (const int ti)
virtual int	get_meta_data_length ()
virtual int	get_topic_id ()
virtual float	get_reference_point_x () const
virtual float	get_reference_point_y () const
virtual float	get_ra_reference_point () const
virtual float	get_dec_reference_point () const
virtual float	get_arcsec_pixel_x () const
virtual float	get_arcsec_pixel_y () const
virtual float	get_rotation_x () const
virtual float	get_cd1_1 () const
virtual float	get_cd1_2 () const
virtual float	get_cd2_1 () const
virtual float	get_cd2_2 () const
virtual float	get_epoch_equinox () const
virtual std::string	get_type_1 () const
virtual std::string	get_type_2 () const

Protected Attributes
ddt::MetaDataBinaryxD	meta_data_binary_xd
Protected Attributes inherited from DdtEncDec
int	topic_id = 0
int	meta_data_length = 0

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

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

DdtEncDecBinaryxD()

DdtEncDecBinaryxD::DdtEncDecBinaryxD ( )

explicit

Constructor

~DdtEncDecBinaryxD()

DdtEncDecBinaryxD::~DdtEncDecBinaryxD ( )

overridedefault

Destructor

Member Function Documentation

Decode()

void DdtEncDecBinaryxD::Decode	(	const int	length,
		std::vector< uint8_t >	meta_data )

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

Parameters

length	The length of the meta data.
meta_data	The meta data.

Encode()

void DdtEncDecBinaryxD::Encode

(

MetaDataElementsBinaryxD const &

meta_data

)

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.

Parameters

meta_data

The meta data.

get_array_dimensions()

std::string DdtEncDecBinaryxD::get_array_dimensions

(

)

const

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

get_byte_order_little_endian()

bool DdtEncDecBinaryxD::get_byte_order_little_endian ( ) const

overridevirtual

Return the byte_order_little_endian member.

Reimplemented from DdtEncDec.

get_bytes_per_pixel()

uint32_t DdtEncDecBinaryxD::get_bytes_per_pixel ( ) const

overridevirtual

Return the bytes_per_pixel member.

Reimplemented from DdtEncDec.

get_complete_flag()

bool DdtEncDecBinaryxD::get_complete_flag ( ) const

overridevirtual

Return the complete_flag member.

Reimplemented from DdtEncDec.

get_configuration_map_name()

std::string DdtEncDecBinaryxD::get_configuration_map_name

(

)

const

Return the name of the configuration map.

get_data_type()

uint32_t DdtEncDecBinaryxD::get_data_type ( ) const

overridevirtual

Return the data_type member.

Reimplemented from DdtEncDec.

get_data_type_str()

std::string DdtEncDecBinaryxD::get_data_type_str ( ) const

overridevirtual

Return data_type member value as a string.

Reimplemented from DdtEncDec.

get_description()

std::string DdtEncDecBinaryxD::get_description ( ) const

overridevirtual

Return the description member.

Reimplemented from DdtEncDec.

get_labels()

std::string DdtEncDecBinaryxD::get_labels

(

)

const

Return the labels.

get_last_segment()

bool DdtEncDecBinaryxD::get_last_segment ( ) const

overridevirtual

Return the last_segment member.

Reimplemented from DdtEncDec.

get_meta_data()

std::vector< uint8_t > DdtEncDecBinaryxD::get_meta_data

(

)

const

Return the meta data as vector of bytes.

Returns

A vector containing the meta data.

Returns the meta data Serializes the data to a string and transforms it into a vector.

get_number_dimensions()

uint32_t DdtEncDecBinaryxD::get_number_dimensions ( ) const

overridevirtual

Return the number_dimensions member.

Reimplemented from DdtEncDec.

get_utc_timestamp()

std::string DdtEncDecBinaryxD::get_utc_timestamp ( ) const

overridevirtual

Return the utc_timestamp member.

Reimplemented from DdtEncDec.

Member Data Documentation

meta_data_binary_xd

ddt::MetaDataBinaryxD DdtEncDecBinaryxD::meta_data_binary_xd

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/encoderdecoder/src/include/ddt/ddtEncDecBinaryxD.hpp
• datatransfer/encoderdecoder/src/ddtEncDecBinaryxD.cpp