ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO Class Reference

#include <FrTOCSummaryClassicIO.hh>

Inheritance diagram for FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO:
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 n_type
typedef INT_4U n_type
typedef std::string name_type
typedef std::string name_type
typedef INT_8U position_type
typedef INT_8U position_type
typedef std::vector< position_type > info_type
typedef std::vector< position_type > info_type
typedef std::map< name_type, info_type > MapSummary_type
typedef std::map< name_type, info_type > MapSummary_type
typedef std::vector< name_type > key_container_type
typedef std::vector< name_type > key_container_type

Public Member Functions

 FrTOCSummaryClassicIO ()=default
Common::FrameSpec::size_type Bytes (const stream_base_type &Stream) const
void Load (istream_type &Stream, INT_4U FrameCount)
 Read contents from stream.
FrTOCSummaryClassicIO & operator= (const Previous::FrTOCImpl::FrTOCSummaryClassicIO &Source)
void QuerySum (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSummary being written.
 FrTOCSummaryClassicIO ()=default
Common::FrameSpec::size_type Bytes (const stream_base_type &Stream) const
void Load (istream_type &Stream, INT_4U FrameCount)
 Read contents from stream.
FrTOCSummaryClassicIO & operator= (const Previous::FrTOCImpl::FrTOCSummaryClassicIO &Source)
void QuerySum (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSummary being written.
const key_container_type & GetPositionKeys () const
const key_container_type & GetPositionKeys () const
const MapSummary_type & GetSummary () const
 Return all channels.
MapSummary_type::const_iterator GetSummary (const std::string &Channel) const
 Return the indexed data for a named channel.
MapSummary_type::const_iterator GetSummary (INT_4U Channel) const
 Return the indexed data for a named channel.
const MapSummary_type & GetSummary () const
 Return all channels.
MapSummary_type::const_iterator GetSummary (const std::string &Channel) const
 Return the indexed data for a named channel.
MapSummary_type::const_iterator GetSummary (INT_4U Channel) const
 Return the indexed data for a named channel.

Static Public Member Functions

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

Protected Types

typedef STRING io_name_type
typedef std::vector< io_name_type > io_key_container_type
typedef STRING io_name_type
typedef std::vector< io_name_type > io_key_container_type

Protected Member Functions

const io_key_container_type & GetIOPositionKeys () const
void write (ostream_type &Stream) const
 Write the structure to the stream.
const io_key_container_type & GetIOPositionKeys () const
void write (ostream_type &Stream) const
 Write the structure to the stream.

Protected Attributes

io_key_container_type m_io_keys
key_container_type m_keys
MapSummary_type m_info

Private Attributes

Common::FrTOC::cmn_name_container_type name_keys

Member Typedef Documentation

◆ frame_count_type [1/2]

typedef INT_4U FrameCPP::v8::FrTOCSummary::frame_count_type
inherited

◆ frame_count_type [2/2]

typedef INT_4U FrameCPP::v8::FrTOCSummary::frame_count_type
inherited

◆ info_type [1/2]

typedef std::vector< position_type > FrameCPP::v8::FrTOCSummary::info_type
inherited

◆ info_type [2/2]

typedef std::vector< position_type > FrameCPP::v8::FrTOCSummary::info_type
inherited

◆ io_key_container_type [1/2]

typedef std::vector< io_name_type > FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::io_key_container_type
protected

◆ io_key_container_type [2/2]

typedef std::vector< io_name_type > FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::io_key_container_type
protected

◆ io_name_type [1/2]

typedef STRING FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::io_name_type
protected

◆ io_name_type [2/2]

typedef STRING FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::io_name_type
protected

◆ key_container_type [1/2]

typedef std::vector< name_type > FrameCPP::v8::FrTOCSummary::key_container_type
inherited

◆ key_container_type [2/2]

typedef std::vector< name_type > FrameCPP::v8::FrTOCSummary::key_container_type
inherited

◆ MapSummary_type [1/2]

typedef std::map< name_type, info_type > FrameCPP::v8::FrTOCSummary::MapSummary_type
inherited

◆ MapSummary_type [2/2]

typedef std::map< name_type, info_type > FrameCPP::v8::FrTOCSummary::MapSummary_type
inherited

◆ n_type [1/2]

typedef INT_4U FrameCPP::v8::FrTOCSummary::n_type
inherited

◆ n_type [2/2]

typedef INT_4U FrameCPP::v8::FrTOCSummary::n_type
inherited

◆ name_type [1/2]

typedef std::string FrameCPP::v8::FrTOCSummary::name_type
inherited

◆ name_type [2/2]

typedef std::string FrameCPP::v8::FrTOCSummary::name_type
inherited

◆ position_type [1/2]

typedef INT_8U FrameCPP::v8::FrTOCSummary::position_type
inherited

◆ position_type [2/2]

typedef INT_8U FrameCPP::v8::FrTOCSummary::position_type
inherited

Constructor & Destructor Documentation

◆ FrTOCSummaryClassicIO() [1/2]

FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::FrTOCSummaryClassicIO ( )
default

◆ FrTOCSummaryClassicIO() [2/2]

FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::FrTOCSummaryClassicIO ( )
default

Member Function Documentation

◆ Bytes() [1/2]

Common::FrameSpec::size_type FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::Bytes ( const stream_base_type & Stream) const
inline

◆ Bytes() [2/2]

Common::FrameSpec::size_type FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::Bytes ( const stream_base_type & Stream) const
inline

◆ Description() [1/2]

template<typename SE>
void FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::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/2]

template<typename SE>
void FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::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/2]

const io_key_container_type & FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::GetIOPositionKeys ( ) const
inlineprotected

◆ GetIOPositionKeys() [2/2]

const io_key_container_type & FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::GetIOPositionKeys ( ) const
inlineprotected

◆ GetPositionKeys() [1/2]

const key_container_type & FrameCPP::v8::FrTOCSummary::GetPositionKeys ( ) const
inlineinherited

◆ GetPositionKeys() [2/2]

const key_container_type & FrameCPP::v8::FrTOCSummary::GetPositionKeys ( ) const
inlineinherited

◆ GetSummary() [1/6]

const MapSummary_type & FrameCPP::v8::FrTOCSummary::GetSummary ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrSummary elements.

◆ GetSummary() [2/6]

const MapSummary_type & FrameCPP::v8::FrTOCSummary::GetSummary ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrSummary elements.

◆ GetSummary() [3/6]

MapSummary_type::const_iterator FrameCPP::v8::FrTOCSummary::GetSummary ( 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 FrSummary element.

◆ GetSummary() [4/6]

MapSummary_type::const_iterator FrameCPP::v8::FrTOCSummary::GetSummary ( 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 FrSummary element.

◆ GetSummary() [5/6]

MapSummary_type::const_iterator FrameCPP::v8::FrTOCSummary::GetSummary ( 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 FrSummary element.

◆ GetSummary() [6/6]

MapSummary_type::const_iterator FrameCPP::v8::FrTOCSummary::GetSummary ( 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 FrSummary element.

◆ Load() [1/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::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/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::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/2]

FrTOCSummaryClassicIO & FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::operator= ( const Previous::FrTOCImpl::FrTOCSummaryClassicIO & Source)
inline

◆ operator=() [2/2]

FrTOCSummaryClassicIO & FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::operator= ( const Previous::FrTOCImpl::FrTOCSummaryClassicIO & Source)
inline

◆ QuerySum() [1/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::QuerySum ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inline

Gather TOC info for FrSummary 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.

◆ QuerySum() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::QuerySum ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inline

Gather TOC info for FrSummary 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/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::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/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::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

MapSummary_type FrTOCSummary::m_info
protectedinherited

◆ m_io_keys

io_key_container_type FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::m_io_keys
protected

◆ m_keys

key_container_type FrTOCSummary::m_keys
protectedinherited

◆ name_keys

Common::FrTOC::cmn_name_container_type FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::name_keys
private
The documentation for this class was generated from the following files:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version9/impl/FrTOCSummaryClassicIO.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version9/impl/FrTOCSummaryClassicIO.hh