#include <ddtEncDecImage2D.hpp>

Inheritance diagram for DdtEncDecImage2D:

Public Member Functions

	DdtEncDecImage2D ()

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

void	Encode (MetaDataElementsImage2D const &meta_data)

	~DdtEncDecImage2D () 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_description () const override

uint32_t	get_number_pixels_x () const

uint32_t	get_number_pixels_y () const

int32_t	get_binning_factor_x () const

int32_t	get_binning_factor_y () const

uint32_t	get_first_pixel_x () const

uint32_t	get_first_pixel_y () const

uint32_t	get_number_chunks_x () const

uint32_t	get_number_chunks_y () const

uint32_t	get_image_id () const

float	get_reference_point_x () const override

float	get_reference_point_y () const override

float	get_ra_reference_point () const override

float	get_dec_reference_point () const override

float	get_arcsec_pixel_x () const override

float	get_arcsec_pixel_y () const override

float	get_rotation_x () const override

float	get_cd1_1 () const override

float	get_cd1_2 () const override

float	get_cd2_1 () const override

float	get_cd2_2 () const override

float	get_epoch_equinox () const override

std::string	get_type_1 () const override

std::string	get_type_2 () const override

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 ()

Protected Attributes
ddt::MetaDataImage2D	meta_data_image_2d

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 2-dimensional image data samples

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

◆ DdtEncDecImage2D()

DdtEncDecImage2D::DdtEncDecImage2D ( )

explicit

Constructor

Set the topic id This meta data object is marked as 2-dimensional image meta data

◆ ~DdtEncDecImage2D()

DdtEncDecImage2D::~DdtEncDecImage2D ( )

overridedefault

Destructor

Member Function Documentation

◆ Decode()

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

Decode a meta data block into the 2-dimensional image meta data

Parameters

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

◆ Encode()

void DdtEncDecImage2D::Encode ( MetaDataElementsImage2D 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_arcsec_pixel_x()

float DdtEncDecImage2D::get_arcsec_pixel_x ( ) const

overridevirtual

Return the arcsec_pixel_x member.

Reimplemented from DdtEncDec.

◆ get_arcsec_pixel_y()

float DdtEncDecImage2D::get_arcsec_pixel_y ( ) const

overridevirtual

Return the arcsec_pixel_y member.

Reimplemented from DdtEncDec.

◆ get_binning_factor_x()

int32_t DdtEncDecImage2D::get_binning_factor_x ( ) const

Return the binnning_factor_x member.

◆ get_binning_factor_y()

int32_t DdtEncDecImage2D::get_binning_factor_y ( ) const

Return the binning_factor_y member.

◆ get_byte_order_little_endian()

bool DdtEncDecImage2D::get_byte_order_little_endian ( ) const

overridevirtual

Return the byte_order_little_endian member.

Reimplemented from DdtEncDec.

◆ get_bytes_per_pixel()

uint32_t DdtEncDecImage2D::get_bytes_per_pixel ( ) const

overridevirtual

Return the bytes_per_pixel member.

Reimplemented from DdtEncDec.

◆ get_cd1_1()

float DdtEncDecImage2D::get_cd1_1 ( ) const

overridevirtual

Return the cd1_1 member.

Reimplemented from DdtEncDec.

◆ get_cd1_2()

float DdtEncDecImage2D::get_cd1_2 ( ) const

overridevirtual

Return the cd1_2 member.

Reimplemented from DdtEncDec.

◆ get_cd2_1()

float DdtEncDecImage2D::get_cd2_1 ( ) const

overridevirtual

Return the cd2_1 member.

Reimplemented from DdtEncDec.

◆ get_cd2_2()

float DdtEncDecImage2D::get_cd2_2 ( ) const

overridevirtual

Return the cd2_2 member.

Reimplemented from DdtEncDec.

◆ get_complete_flag()

bool DdtEncDecImage2D::get_complete_flag ( ) const

overridevirtual

Return the complete_flag member.

Reimplemented from DdtEncDec.

◆ get_data_type()

uint32_t DdtEncDecImage2D::get_data_type ( ) const

overridevirtual

Return the data_type member.

Reimplemented from DdtEncDec.

◆ get_dec_reference_point()

float DdtEncDecImage2D::get_dec_reference_point ( ) const

overridevirtual

Return the dec_reference_point member.

Reimplemented from DdtEncDec.

◆ get_description()

std::string DdtEncDecImage2D::get_description ( ) const

overridevirtual

Return the description member.

Reimplemented from DdtEncDec.

◆ get_epoch_equinox()

float DdtEncDecImage2D::get_epoch_equinox ( ) const

overridevirtual

Return the epoch_equinox member.

Reimplemented from DdtEncDec.

◆ get_first_pixel_x()

uint32_t DdtEncDecImage2D::get_first_pixel_x ( ) const

Return the first_pixel_x member.

◆ get_first_pixel_y()

uint32_t DdtEncDecImage2D::get_first_pixel_y ( ) const

Return the first_pixel_y member.

◆ get_image_id()

uint32_t DdtEncDecImage2D::get_image_id ( ) const

Return the image_id member.

◆ get_last_segment()

bool DdtEncDecImage2D::get_last_segment ( ) const

overridevirtual

Return the last_segment member.

Reimplemented from DdtEncDec.

◆ get_meta_data()

std::vector< uint8_t > DdtEncDecImage2D::get_meta_data ( ) const

Return the meta data as vector of bytes.

Returns: A vector containing the meta data.

◆ get_number_chunks_x()

uint32_t DdtEncDecImage2D::get_number_chunks_x ( ) const

Return the number_chunks_x member.

◆ get_number_chunks_y()

uint32_t DdtEncDecImage2D::get_number_chunks_y ( ) const

Return the number_chunks_x member.

◆ get_number_dimensions()

uint32_t DdtEncDecImage2D::get_number_dimensions ( ) const

overridevirtual

Return the number_dimensions member.

Reimplemented from DdtEncDec.

◆ get_number_pixels_x()

uint32_t DdtEncDecImage2D::get_number_pixels_x ( ) const

Return the number_pixels_x member.

◆ get_number_pixels_y()

uint32_t DdtEncDecImage2D::get_number_pixels_y ( ) const

Return the number_pixels_y member.

◆ get_ra_reference_point()

float DdtEncDecImage2D::get_ra_reference_point ( ) const

overridevirtual

Return the ra_reference_point member.

Reimplemented from DdtEncDec.

◆ get_reference_point_x()

float DdtEncDecImage2D::get_reference_point_x ( ) const

overridevirtual

Return the reference_point_x member.

Reimplemented from DdtEncDec.

◆ get_reference_point_y()

float DdtEncDecImage2D::get_reference_point_y ( ) const

overridevirtual

Return the reference_point_y member.

Reimplemented from DdtEncDec.

◆ get_rotation_x()

float DdtEncDecImage2D::get_rotation_x ( ) const

overridevirtual

Return the rotation_x_axis member.

Reimplemented from DdtEncDec.

◆ get_type_1()

std::string DdtEncDecImage2D::get_type_1 ( ) const

overridevirtual

Return the type 1 projection member.

Reimplemented from DdtEncDec.

◆ get_type_2()

std::string DdtEncDecImage2D::get_type_2 ( ) const

overridevirtual

Return the type 2 projection member.

Reimplemented from DdtEncDec.

◆ get_utc_timestamp()

std::string DdtEncDecImage2D::get_utc_timestamp ( ) const

overridevirtual

Return the utc_timestamp member.

Reimplemented from DdtEncDec.

Member Data Documentation

◆ meta_data_image_2d

ddt::MetaDataImage2D DdtEncDecImage2D::meta_data_image_2d

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/ddtEncDecImage2D.hpp
datatransfer/encoderdecoder/src/ddtEncDecImage2D.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DdtEncDecImage2D()

◆ ~DdtEncDecImage2D()

Member Function Documentation

◆ Decode()

◆ Encode()

◆ get_arcsec_pixel_x()

◆ get_arcsec_pixel_y()

◆ get_binning_factor_x()

◆ get_binning_factor_y()

◆ get_byte_order_little_endian()

◆ get_bytes_per_pixel()

◆ get_cd1_1()

◆ get_cd1_2()

◆ get_cd2_1()

◆ get_cd2_2()

◆ get_complete_flag()

◆ get_data_type()

◆ get_dec_reference_point()

◆ get_description()

◆ get_epoch_equinox()

◆ get_first_pixel_x()

◆ get_first_pixel_y()

◆ get_image_id()

◆ get_last_segment()

◆ get_meta_data()

◆ get_number_chunks_x()

◆ get_number_chunks_y()

◆ get_number_dimensions()

◆ get_number_pixels_x()

◆ get_number_pixels_y()

◆ get_ra_reference_point()

◆ get_reference_point_x()

◆ get_reference_point_y()

◆ get_rotation_x()

◆ get_type_1()

◆ get_type_2()

◆ get_utc_timestamp()

Member Data Documentation

◆ meta_data_image_2d