ldas-tools-framecpp  2.7.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | 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]

Public Member Functions

 FrTOCSummary ()
 Default constructor.
 
const MapSummary_type & GetSummary () const
 Return all summary elements. More...
 
MapSummary_type::const_iterator GetSummary (const std::string &Name) const
 Return the indexed data for a named summary elemnet. More...
 
MapSummary_type::const_iterator GetSummary (INT_4U index) const
 Return the indexed data for an index summary element. More...
 
void QuerySum (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSummary being written. More...
 
const FrTOCSummaryoperator= (const Previous::FrTOCSummary &Source)
 asignment operator More...
 
bool operator== (const FrTOCSummary &RHS) const
 equality operator More...
 
 FrTOCSummary ()
 Default constructor.
 
const MapSummary_type & GetSummary () const
 Return all summary elements. More...
 
MapSummary_type::const_iterator GetSummary (const std::string &Name) const
 Return the indexed data for a named summary elemnet. More...
 
MapSummary_type::const_iterator GetSummary (INT_4U index) const
 Return the indexed data for an index summary element. More...
 
void QuerySum (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSummary being written. More...
 
const FrTOCSummaryoperator= (const Previous::FrTOCSummary &Source)
 asignment operator More...
 
bool operator== (const FrTOCSummary &RHS) const
 equality operator 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...
 

Protected Member Functions

 FrTOCSummary (Common::IStream &Stream, INT_4U FrameCount)
 Stream constructor. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
 FrTOCSummary (Common::IStream &Stream, INT_4U FrameCount)
 Stream constructor. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 

Detailed Description

Indexed elements of the FrSummary structure.

Constructor & Destructor Documentation

◆ FrTOCSummary() [1/2]

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() [2/2]

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

◆ 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.

◆ 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]

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() [4/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() [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/2]

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==() [2/2]

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.

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