#include <ddtEncDec.hpp>

Inheritance diagram for DdtEncDec:

Protected Attributes
int	topic_id = 0

int	meta_data_length = 0

	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 uint32_t	get_bytes_per_pixel () const

virtual uint32_t	get_number_dimensions () const

virtual std::string	get_utc_timestamp () const

virtual bool	get_complete_flag () const

virtual bool	get_last_segment () const

virtual bool	get_byte_order_little_endian () const

virtual uint32_t	get_data_type () const

virtual std::string	get_data_type_str () const

virtual std::string	get_description () const

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

std::string	get_current_time () const

Detailed Description

Base class for encoding / decoding of data samples.

Constructor & Destructor Documentation

◆ DdtEncDec()

DdtEncDec::DdtEncDec ( )

explicitdefault

Constructor

◆ ~DdtEncDec()

DdtEncDec::~DdtEncDec ( )

pure virtualdefault

Destructor

Member Function Documentation

◆ get_arcsec_pixel_x()

float DdtEncDec::get_arcsec_pixel_x ( ) const

virtual

Return the arcsec_pixel_x member.

Reimplemented in DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_arcsec_pixel_y()

float DdtEncDec::get_arcsec_pixel_y ( ) const

virtual

Return the arcsec_pixel_y member.

Reimplemented in DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_byte_order_little_endian()

bool DdtEncDec::get_byte_order_little_endian ( ) const

virtual

Return the byte_order_little_endian member.

Reimplemented in DdtEncDecBinaryxD, DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_bytes_per_pixel()

uint32_t DdtEncDec::get_bytes_per_pixel ( ) const

virtual

Return the bytes_per_pixel member.

Reimplemented in DdtEncDecBinaryxD, DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_cd1_1()

float DdtEncDec::get_cd1_1 ( ) const

virtual

Return the cd1_1 member.

Reimplemented in DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_cd1_2()

float DdtEncDec::get_cd1_2 ( ) const

virtual

Return the cd1_2 member.

Reimplemented in DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_cd2_1()

float DdtEncDec::get_cd2_1 ( ) const

virtual

Return the cd2_1 member.

Reimplemented in DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_cd2_2()

float DdtEncDec::get_cd2_2 ( ) const

virtual

Return the cd2_2 member.

Reimplemented in DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_complete_flag()

bool DdtEncDec::get_complete_flag ( ) const

virtual

Return the complete_flag member.

Reimplemented in DdtEncDecBinaryxD, DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_current_time()

std::string DdtEncDec::get_current_time ( ) const

protected

Return the current time including milliseconds

◆ get_data_type()

uint32_t DdtEncDec::get_data_type ( ) const

virtual

Return the data_type member.

Reimplemented in DdtEncDecBinaryxD, DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_data_type_str()

std::string DdtEncDec::get_data_type_str ( ) const

virtual

Return data_type member value as a string.

Reimplemented in DdtEncDecBinaryxD, DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_dec_reference_point()

float DdtEncDec::get_dec_reference_point ( ) const

virtual

Return the dec_reference_point member.

Reimplemented in DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_description()

std::string DdtEncDec::get_description ( ) const

virtual

Return the description member.

Reimplemented in DdtEncDecBinaryxD, DdtEncDecImage2D, and DdtEncDecImage3D.

◆ get_epoch_equinox()

float DdtEncDec::get_epoch_equinox ( ) const

virtual

Return the epoch_equinox member.

Reimplemented in DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_last_segment()

bool DdtEncDec::get_last_segment ( ) const

virtual

Return the last_segment member.

Reimplemented in DdtEncDecBinaryxD, DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_meta_data_length()

int DdtEncDec::get_meta_data_length ( )

virtual

Returns the meta data length.

Reimplemented in PyEncDec.

◆ get_number_dimensions()

uint32_t DdtEncDec::get_number_dimensions ( ) const

virtual

Return the number_dimensions member.

Reimplemented in DdtEncDecBinaryxD, DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_ra_reference_point()

float DdtEncDec::get_ra_reference_point ( ) const

virtual

Return the ra_reference_point member.

Reimplemented in DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_reference_point_x()

float DdtEncDec::get_reference_point_x ( ) const

virtual

Return the reference_point_x member.

Reimplemented in DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_reference_point_y()

float DdtEncDec::get_reference_point_y ( ) const

virtual

Return the reference_point_y member.

Reimplemented in DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_rotation_x()

float DdtEncDec::get_rotation_x ( ) const

virtual

Return the rotation_x_axis member.

Reimplemented in DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_topic_id()

int DdtEncDec::get_topic_id ( )

virtual

Return the topic id.

Reimplemented in PyEncDec.

◆ get_type_1()

std::string DdtEncDec::get_type_1 ( ) const

virtual

Return the type 1 projection member.

Reimplemented in DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_type_2()

std::string DdtEncDec::get_type_2 ( ) const

virtual

Return the type 2 projection member.

Reimplemented in DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ get_utc_timestamp()

std::string DdtEncDec::get_utc_timestamp ( ) const

virtual

Return the utc_timestamp member.

Reimplemented in DdtEncDecBinaryxD, DdtEncDecImage2D, DdtEncDecImage3D, and PyEncDec.

◆ set_meta_data_length()

void DdtEncDec::set_meta_data_length ( const int mdl )

virtual

Sets the meta data length.

Reimplemented in PyEncDec.

◆ set_topic_id()

void DdtEncDec::set_topic_id ( const int ti )

Sets the topic id.

Parameters

ti	The topic ID.

Member Data Documentation

◆ meta_data_length

int DdtEncDec::meta_data_length = 0

protected

The length of the meta data block

◆ topic_id

int DdtEncDec::topic_id = 0

protected

The topic ID is used to distinguish meta data shapes from each other

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

datatransfer/encoderdecoder/src/include/ddt/ddtEncDec.hpp
datatransfer/encoderdecoder/src/ddtEncDec.cpp

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DdtEncDec()

◆ ~DdtEncDec()

Member Function Documentation

◆ get_arcsec_pixel_x()

◆ get_arcsec_pixel_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_current_time()

◆ get_data_type()

◆ get_data_type_str()

◆ get_dec_reference_point()

◆ get_description()

◆ get_epoch_equinox()

◆ get_last_segment()

◆ get_meta_data_length()

◆ get_number_dimensions()

◆ get_ra_reference_point()

◆ get_reference_point_x()

◆ get_reference_point_y()

◆ get_rotation_x()

◆ get_topic_id()

◆ get_type_1()

◆ get_type_2()

◆ get_utc_timestamp()

◆ set_meta_data_length()

◆ set_topic_id()

Member Data Documentation

◆ meta_data_length

◆ topic_id