ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_8::FrTOCSummary Class Reference

Indexed elements of the FrSummary structure. More...

#include <FrTOCSummary.hh>

Inheritance diagram for FrameCPP::Version_8::FrTOCSummary:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_8::FrTOCSummary:
Collaboration graph
[legend]

Public Types

typedef FrTOCPosition::n_type nsummary_type
 
typedef FrTOCPosition::position_type position_type
 
typedef FrTOCPosition::info_type summary_info_type
 
typedef FrTOCPosition::Map_type MapSummary_type
 
typedef FrTOCPosition::n_type nsummary_type
 
typedef FrTOCPosition::position_type position_type
 
typedef FrTOCPosition::info_type summary_info_type
 
typedef FrTOCPosition::Map_type MapSummary_type
 
typedef INT_4U frame_count_type
 
typedef INT_4U frame_count_type
 
typedef INT_4U n_type
 
typedef INT_4U n_type
 
typedef STRING name_type
 
typedef STRING name_type
 
typedef std::vector< position_typeinfo_type
 
typedef std::vector< position_typeinfo_type
 
typedef std::map< name_type, info_typeMap_type
 
typedef std::map< name_type, info_typeMap_type
 
typedef std::vector< name_typekey_container_type
 
typedef std::vector< name_typekey_container_type
 

Public Member Functions

 FrTOCSummary ()
 Default constructor.
 
const MapSummary_typeGetSummary () const
 Return all summary elements.
 
MapSummary_type::const_iterator GetSummary (const std::string &Name) const
 Return the indexed data for a named summary elemnet.
 
MapSummary_type::const_iterator GetSummary (INT_4U index) const
 Return the indexed data for an index summary element.
 
void QuerySum (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSummary being written.
 
const FrTOCSummaryoperator= (const Previous::FrTOCSummary &Source)
 asignment operator
 
bool operator== (const FrTOCSummary &RHS) const
 equality operator
 
 FrTOCSummary ()
 Default constructor.
 
const MapSummary_typeGetSummary () const
 Return all summary elements.
 
MapSummary_type::const_iterator GetSummary (const std::string &Name) const
 Return the indexed data for a named summary elemnet.
 
MapSummary_type::const_iterator GetSummary (INT_4U index) const
 Return the indexed data for an index summary element.
 
void QuerySum (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSummary being written.
 
const FrTOCSummaryoperator= (const Previous::FrTOCSummary &Source)
 asignment operator
 
bool operator== (const FrTOCSummary &RHS) const
 equality operator
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 
const key_container_typeGetPositionKeys () const
 
const key_container_typeGetPositionKeys () const
 

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 Member Functions

 FrTOCSummary (Common::IStream &Stream, INT_4U FrameCount)
 Stream constructor.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
 FrTOCSummary (Common::IStream &Stream, INT_4U FrameCount)
 Stream constructor.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
const Map_typegetInfo () const
 
Map_type::const_iterator getInfo (const std::string &Name) const
 
Map_type::const_iterator getInfo (INT_4U Index) const
 
const Map_typegetInfo () const
 
Map_type::const_iterator getInfo (const std::string &Name) const
 
Map_type::const_iterator getInfo (INT_4U Index) const
 
bool operator== (const FrTOCPosition &RHS) const
 

Protected Attributes

key_container_type m_keys
 
Map_type m_info
 

Detailed Description

Indexed elements of the FrSummary structure.

Member Typedef Documentation

◆ frame_count_type [1/2]

◆ frame_count_type [2/2]

◆ info_type [1/2]

◆ info_type [2/2]

◆ key_container_type [1/2]

◆ key_container_type [2/2]

◆ Map_type [1/2]

◆ Map_type [2/2]

◆ MapSummary_type [1/2]

◆ MapSummary_type [2/2]

◆ n_type [1/2]

◆ n_type [2/2]

◆ name_type [1/2]

◆ name_type [2/2]

◆ nsummary_type [1/2]

◆ nsummary_type [2/2]

◆ position_type [1/2]

◆ position_type [2/2]

◆ summary_info_type [1/2]

◆ summary_info_type [2/2]

Constructor & Destructor Documentation

◆ FrTOCSummary() [1/4]

FrameCPP::Version_8::FrTOCSummary::FrTOCSummary ( )
inline

Default constructor.

◆ FrTOCSummary() [2/4]

FrameCPP::Version_8::FrTOCSummary::FrTOCSummary ( Common::IStream Stream,
INT_4U  FrameCount 
)
inlineprotected

Stream constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
[in]FrameCountThe frame offset.

◆ FrTOCSummary() [3/4]

FrameCPP::Version_8::FrTOCSummary::FrTOCSummary ( )

Default constructor.

◆ FrTOCSummary() [4/4]

FrameCPP::Version_8::FrTOCSummary::FrTOCSummary ( Common::IStream Stream,
INT_4U  FrameCount 
)
protected

Stream constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
[in]FrameCountThe frame offset.

Member Function Documentation

◆ Bytes() [1/2]

Common::FrameSpec::size_type FrameCPP::Version_4::FrTOCPosition::Bytes ( const Common::StreamBase Stream) const
inlineinherited

◆ Bytes() [2/2]

Common::FrameSpec::size_type FrameCPP::Version_4::FrTOCPosition::Bytes ( const Common::StreamBase Stream) const
inherited

◆ Description() [1/2]

template<typename SE >
void FrameCPP::Version_8::FrTOCSummary::Description ( Common::Description Desc)
static

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.

◆ Description() [2/2]

template<typename SE >
static void FrameCPP::Version_8::FrTOCSummary::Description ( Common::Description Desc)
static

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.

◆ getInfo() [1/6]

const FrTOCPosition::Map_type & FrameCPP::Version_4::FrTOCPosition::getInfo ( ) const
inlineprotectedinherited

◆ getInfo() [2/6]

const Map_type & FrameCPP::Version_4::FrTOCPosition::getInfo ( ) const
protectedinherited

◆ getInfo() [3/6]

FrTOCPosition::Map_type::const_iterator FrameCPP::Version_4::FrTOCPosition::getInfo ( const std::string &  Name) const
inlineprotectedinherited

◆ getInfo() [4/6]

Map_type::const_iterator FrameCPP::Version_4::FrTOCPosition::getInfo ( const std::string &  Name) const
protectedinherited

◆ getInfo() [5/6]

FrTOCPosition::Map_type::const_iterator FrameCPP::Version_4::FrTOCPosition::getInfo ( INT_4U  Index) const
inlineprotectedinherited

◆ getInfo() [6/6]

Map_type::const_iterator FrameCPP::Version_4::FrTOCPosition::getInfo ( INT_4U  Index) const
protectedinherited

◆ GetPositionKeys() [1/2]

const FrTOCPosition::key_container_type & FrameCPP::Version_4::FrTOCPosition::GetPositionKeys ( ) const
inlineinherited

◆ GetPositionKeys() [2/2]

const key_container_type & FrameCPP::Version_4::FrTOCPosition::GetPositionKeys ( ) const
inherited

◆ GetSummary() [1/6]

const FrTOCSummary::MapSummary_type & FrameCPP::Version_8::FrTOCSummary::GetSummary ( ) const
inline

Return all summary elements.

Returns
Constant container to the indexed FrSummary elements.

◆ GetSummary() [2/6]

const MapSummary_type & FrameCPP::Version_8::FrTOCSummary::GetSummary ( ) const

Return all summary elements.

Returns
Constant container to the indexed FrSummary elements.

◆ GetSummary() [3/6]

FrTOCSummary::MapSummary_type::const_iterator FrameCPP::Version_8::FrTOCSummary::GetSummary ( const std::string &  Name) const
inline

Return the indexed data for a named summary elemnet.

Parameters
[in]NameThe name of the summary elment.
Returns
Constant iterator to the indexed FrSummary element.

◆ GetSummary() [4/6]

MapSummary_type::const_iterator FrameCPP::Version_8::FrTOCSummary::GetSummary ( const std::string &  Name) const

Return the indexed data for a named summary elemnet.

Parameters
[in]NameThe name of the summary elment.
Returns
Constant iterator to the indexed FrSummary element.

◆ GetSummary() [5/6]

FrTOCSummary::MapSummary_type::const_iterator FrameCPP::Version_8::FrTOCSummary::GetSummary ( INT_4U  index) const
inline

Return the indexed data for an index summary element.

Parameters
[in]indexThe numeric offset of the summary element.
Returns
Constant iterator to the indexed FrSummary element.

◆ GetSummary() [6/6]

MapSummary_type::const_iterator FrameCPP::Version_8::FrTOCSummary::GetSummary ( INT_4U  index) const

Return the indexed data for an index summary element.

Parameters
[in]indexThe numeric offset of the summary element.
Returns
Constant iterator to the indexed FrSummary element.

◆ operator=() [1/2]

const FrTOCSummary & FrameCPP::Version_8::FrTOCSummary::operator= ( const Previous::FrTOCSummary &  Source)

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator=() [2/2]

const FrTOCSummary & FrameCPP::Version_8::FrTOCSummary::operator= ( const Previous::FrTOCSummary &  Source)

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator==() [1/3]

bool FrameCPP::Version_4::FrTOCPosition::operator== ( const FrTOCPosition RHS) const
protectedinherited

◆ operator==() [2/3]

bool FrameCPP::Version_8::FrTOCSummary::operator== ( const FrTOCSummary RHS) const

equality operator

Parameters
[in]RHSThe FrTOCAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [3/3]

bool FrameCPP::Version_8::FrTOCSummary::operator== ( const FrTOCSummary RHS) const

equality operator

Parameters
[in]RHSThe FrTOCAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ QuerySum() [1/2]

void FrameCPP::Version_8::FrTOCSummary::QuerySum ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)

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_8::FrTOCSummary::QuerySum ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)

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_8::FrTOCSummary::write ( Common::OStream 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_8::FrTOCSummary::write ( Common::OStream Stream) const
protected

Write the structure to the stream.

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

Member Data Documentation

◆ m_info

Map_type FrameCPP::Version_4::FrTOCPosition::m_info
protectedinherited

◆ m_keys

key_container_type FrameCPP::Version_4::FrTOCPosition::m_keys
protectedinherited

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