ldas-tools-framecpp  2.9.3
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO Class Reference

#include <FrTOCSerDataClassicIO.hh>

Inheritance diagram for FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO:
Collaboration graph
[legend]

Classes

struct  byte_counter
 
struct  deflate
 
struct  inflate
 

Public Types

typedef INT_4U frame_count_type
 
typedef INT_4U frame_count_type
 
typedef INT_4U frame_count_type
 
typedef INT_4U n_type
 
typedef INT_4U n_type
 
typedef INT_4U n_type
 
typedef std::string name_type
 
typedef std::string name_type
 
typedef std::string name_type
 
typedef INT_8U position_type
 
typedef INT_8U position_type
 
typedef INT_8U position_type
 
typedef std::vector< position_typeinfo_type
 
typedef std::vector< position_typeinfo_type
 
typedef std::vector< position_typeinfo_type
 
typedef std::map< name_type, info_typeMapSer_type
 
typedef std::map< name_type, info_typeMapSer_type
 
typedef std::map< name_type, info_typeMapSer_type
 
typedef std::vector< name_typekey_container_type
 
typedef std::vector< name_typekey_container_type
 
typedef std::vector< name_typekey_container_type
 

Public Member Functions

 FrTOCSerDataClassicIO ()=default
 
Common::FrameSpec::size_type Bytes (const stream_base_type &Stream) const
 
void Load (istream_type &Stream, INT_4U FrameCount)
 Read contents from stream. More...
 
FrTOCSerDataClassicIOoperator= (const Previous::FrTOCSerData &Source)
 
void QuerySer (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSerData being written. More...
 
 FrTOCSerDataClassicIO ()=default
 
Common::FrameSpec::size_type Bytes (const stream_base_type &Stream) const
 
void Load (istream_type &Stream, INT_4U FrameCount)
 Read contents from stream. More...
 
FrTOCSerDataClassicIOoperator= (const Previous::FrTOCSerData &Source)
 
void QuerySer (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSerData being written. More...
 
 FrTOCSerDataClassicIO ()=default
 
Common::FrameSpec::size_type Bytes (const stream_base_type &Stream) const
 
void Load (istream_type &Stream, INT_4U FrameCount)
 Read contents from stream. More...
 
FrTOCSerDataClassicIOoperator= (const Previous::FrTOCSerData &Source)
 
void QuerySer (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSerData being written. More...
 
const key_container_typeGetPositionKeys () const
 
const key_container_typeGetPositionKeys () const
 
const key_container_typeGetPositionKeys () const
 
const MapSer_typeGetSer () const
 Return all channels. More...
 
MapSer_type::const_iterator GetSer (const std::string &Channel) const
 Return the indexed data for a named channel. More...
 
MapSer_type::const_iterator GetSer (INT_4U Channel) const
 Return the indexed data for a named channel. More...
 
const MapSer_typeGetSer () const
 Return all channels. More...
 
MapSer_type::const_iterator GetSer (const std::string &Channel) const
 Return the indexed data for a named channel. More...
 
MapSer_type::const_iterator GetSer (INT_4U Channel) const
 Return the indexed data for a named channel. More...
 
const MapSer_typeGetSer () const
 Return all channels. More...
 
MapSer_type::const_iterator GetSer (const std::string &Channel) const
 Return the indexed data for a named channel. More...
 
MapSer_type::const_iterator GetSer (INT_4U Channel) const
 Return the indexed data for a named channel. More...
 

Static Public Member Functions

template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure. More...
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure. More...
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure. More...
 

Protected Types

typedef STRING io_name_type
 
typedef std::vector< io_name_typeio_key_container_type
 
typedef STRING io_name_type
 
typedef std::vector< io_name_typeio_key_container_type
 
typedef STRING io_name_type
 
typedef std::vector< io_name_typeio_key_container_type
 

Protected Member Functions

const io_key_container_typeGetIOPositionKeys () const
 
void write (ostream_type &Stream) const
 Write the structure to the stream. More...
 
const io_key_container_typeGetIOPositionKeys () const
 
void write (ostream_type &Stream) const
 Write the structure to the stream. More...
 
const io_key_container_typeGetIOPositionKeys () const
 
void write (ostream_type &Stream) const
 Write the structure to the stream. More...
 

Protected Attributes

io_key_container_type m_io_keys
 
key_container_type m_keys
 
MapSer_type m_info
 

Private Attributes

Common::FrTOC::cmn_name_container_type name_keys
 

Member Typedef Documentation

◆ frame_count_type [1/3]

◆ frame_count_type [2/3]

◆ frame_count_type [3/3]

◆ info_type [1/3]

◆ info_type [2/3]

◆ info_type [3/3]

◆ io_key_container_type [1/3]

◆ io_key_container_type [2/3]

◆ io_key_container_type [3/3]

◆ io_name_type [1/3]

◆ io_name_type [2/3]

◆ io_name_type [3/3]

◆ key_container_type [1/3]

◆ key_container_type [2/3]

◆ key_container_type [3/3]

◆ MapSer_type [1/3]

◆ MapSer_type [2/3]

◆ MapSer_type [3/3]

◆ n_type [1/3]

◆ n_type [2/3]

◆ n_type [3/3]

◆ name_type [1/3]

◆ name_type [2/3]

◆ name_type [3/3]

◆ position_type [1/3]

◆ position_type [2/3]

◆ position_type [3/3]

Constructor & Destructor Documentation

◆ FrTOCSerDataClassicIO() [1/3]

FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::FrTOCSerDataClassicIO ( )
default

◆ FrTOCSerDataClassicIO() [2/3]

FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::FrTOCSerDataClassicIO ( )
default

◆ FrTOCSerDataClassicIO() [3/3]

FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::FrTOCSerDataClassicIO ( )
default

Member Function Documentation

◆ Bytes() [1/3]

Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::Bytes ( const stream_base_type Stream) const
inline

◆ Bytes() [2/3]

Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::Bytes ( const stream_base_type Stream) const
inline

◆ Bytes() [3/3]

Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::Bytes ( const stream_base_type Stream) const
inline

◆ Description() [1/3]

template<typename SE >
static void FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::Description ( Common::Description Desc)
inlinestatic

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ Description() [2/3]

template<typename SE >
static void FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::Description ( Common::Description Desc)
inlinestatic

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ Description() [3/3]

template<typename SE >
static void FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::Description ( Common::Description Desc)
inlinestatic

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ GetIOPositionKeys() [1/3]

const io_key_container_type& FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::GetIOPositionKeys ( ) const
inlineprotected

◆ GetIOPositionKeys() [2/3]

const io_key_container_type& FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::GetIOPositionKeys ( ) const
inlineprotected

◆ GetIOPositionKeys() [3/3]

const io_key_container_type& FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::GetIOPositionKeys ( ) const
inlineprotected

◆ GetPositionKeys() [1/3]

const key_container_type& FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataData::GetPositionKeys ( ) const
inlineinherited

◆ GetPositionKeys() [2/3]

const key_container_type& FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataData::GetPositionKeys ( ) const
inlineinherited

◆ GetPositionKeys() [3/3]

const key_container_type& FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataData::GetPositionKeys ( ) const
inlineinherited

◆ GetSer() [1/9]

const MapSer_type& FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataData::GetSer ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrSerData elements.

◆ GetSer() [2/9]

const MapSer_type& FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataData::GetSer ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrSerData elements.

◆ GetSer() [3/9]

const MapSer_type& FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataData::GetSer ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrSerData elements.

◆ GetSer() [4/9]

MapSer_type::const_iterator FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataData::GetSer ( const std::string &  Channel) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe name of the channel.
Returns
Constant iterator to the indexed FrSerData element.

◆ GetSer() [5/9]

MapSer_type::const_iterator FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataData::GetSer ( const std::string &  Channel) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe name of the channel.
Returns
Constant iterator to the indexed FrSerData element.

◆ GetSer() [6/9]

MapSer_type::const_iterator FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataData::GetSer ( const std::string &  Channel) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe name of the channel.
Returns
Constant iterator to the indexed FrSerData element.

◆ GetSer() [7/9]

MapSer_type::const_iterator FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataData::GetSer ( INT_4U  Channel) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe numeric offset of the channel.
Returns
Constant iterator to the indexed FrSerData element.

◆ GetSer() [8/9]

MapSer_type::const_iterator FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataData::GetSer ( INT_4U  Channel) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe numeric offset of the channel.
Returns
Constant iterator to the indexed FrSerData element.

◆ GetSer() [9/9]

MapSer_type::const_iterator FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataData::GetSer ( INT_4U  Channel) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe numeric offset of the channel.
Returns
Constant iterator to the indexed FrSerData element.

◆ Load() [1/3]

void FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::Load ( istream_type Stream,
INT_4U  FrameCount 
)
inline

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ Load() [2/3]

void FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::Load ( istream_type Stream,
INT_4U  FrameCount 
)
inline

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ Load() [3/3]

void FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::Load ( istream_type Stream,
INT_4U  FrameCount 
)
inline

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ operator=() [1/3]

FrTOCSerDataClassicIO& FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::operator= ( const Previous::FrTOCSerData &  Source)
inline

◆ operator=() [2/3]

FrTOCSerDataClassicIO& FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::operator= ( const Previous::FrTOCSerData &  Source)
inline

◆ operator=() [3/3]

FrTOCSerDataClassicIO& FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::operator= ( const Previous::FrTOCSerData &  Source)
inline

◆ QuerySer() [1/3]

void FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::QuerySer ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inline

Gather TOC info for FrSerData being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ QuerySer() [2/3]

void FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::QuerySer ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inline

Gather TOC info for FrSerData being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ QuerySer() [3/3]

void FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::QuerySer ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inline

Gather TOC info for FrSerData being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ write() [1/3]

void FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::write ( ostream_type Stream) const
inlineprotected

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ write() [2/3]

void FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::write ( ostream_type Stream) const
inlineprotected

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ write() [3/3]

void FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::write ( ostream_type Stream) const
inlineprotected

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Member Data Documentation

◆ m_info

MapSer_type FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataData::m_info
protectedinherited

◆ m_io_keys

io_key_container_type FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::m_io_keys
protected

◆ m_keys

key_container_type FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataData::m_keys
protectedinherited

◆ name_keys

Common::FrTOC::cmn_name_container_type FrameCPP::Version_8::FrTOCImpl::FrTOCSerDataClassicIO::name_keys
private

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