ldas-tools-framecpp  2.6.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
FrameCPP::Version_8::FrTOCSerData Class Reference

Indexed elements of the FrSerData structure. More...

#include <FrTOCSerData.hh>

Inheritance diagram for FrameCPP::Version_8::FrTOCSerData:
FrameCPP::Version_8::FrTOC

Public Types

typedef FrTOCPosition::n_type nser_type
 
typedef
FrTOCPosition::position_type 
position_type
 
typedef FrTOCPosition::info_type ser_info_type
 
typedef FrTOCPosition::Map_type MapSer_type
 

Public Member Functions

 FrTOCSerData ()
 Default constructor. More...
 
const MapSer_typeGetSer () const
 Return all channels. More...
 
MapSer_type::const_iterator GetSer (const std::string &Name) const
 Return the indexed data for a named channel. More...
 
MapSer_type::const_iterator GetSer (INT_4U index) const
 Return the indexed data for a named channel. More...
 
void QuerySer (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSerData being written. More...
 
const FrTOCSerDataoperator= (const Previous::FrTOCSerData &Source)
 asignment operator More...
 
bool operator== (const FrTOCSerData &RHS) const
 equality operator More...
 

Static Public Member Functions

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

Protected Member Functions

 FrTOCSerData (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 FrSerData structure.

Member Typedef Documentation

typedef FrTOCPosition::Map_type FrameCPP::Version_8::FrTOCSerData::MapSer_type
typedef FrTOCPosition::n_type FrameCPP::Version_8::FrTOCSerData::nser_type
typedef FrTOCPosition::position_type FrameCPP::Version_8::FrTOCSerData::position_type
typedef FrTOCPosition::info_type FrameCPP::Version_8::FrTOCSerData::ser_info_type

Constructor & Destructor Documentation

FrameCPP::Version_8::FrTOCSerData::FrTOCSerData ( )
inline

Default constructor.

FrameCPP::Version_8::FrTOCSerData::FrTOCSerData ( 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.

Member Function Documentation

template<typename SE >
void FrameCPP::Version_8::FrTOCSerData::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.
const FrTOCSerData::MapSer_type & FrameCPP::Version_8::FrTOCSerData::GetSer ( ) const
inline

Return all channels.

Returns
Constant container to the indexed FrSerData elements.
FrTOCSerData::MapSer_type::const_iterator FrameCPP::Version_8::FrTOCSerData::GetSer ( const std::string &  Name) const
inline

Return the indexed data for a named channel.

Parameters
[in]NameThe name of the channel.
Returns
Constant iterator to the indexed FrSerData element.
FrTOCSerData::MapSer_type::const_iterator FrameCPP::Version_8::FrTOCSerData::GetSer ( INT_4U  index) const
inline

Return the indexed data for a named channel.

Parameters
[in]indexThe numeric offset of the channel.
Returns
Constant iterator to the indexed FrSerData element.
const FrTOCSerData & FrameCPP::Version_8::FrTOCSerData::operator= ( const Previous::FrTOCSerData &  Source)

asignment operator

Parameters
[in]SourceThe source to be copied.
bool FrameCPP::Version_8::FrTOCSerData::operator== ( const FrTOCSerData 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.
void FrameCPP::Version_8::FrTOCSerData::QuerySer ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)

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.
void FrameCPP::Version_8::FrTOCSerData::write ( Common::OStream Stream) const
inlineprotected

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: