ldas-tools-framecpp  2.7.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
FrameCPP::Version_8::FrTOCSimData Class Reference

Indexed elements of the FrSimData structure. More...

#include <FrTOCSimData.hh>

Inheritance diagram for FrameCPP::Version_8::FrTOCSimData:
Inheritance graph
[legend]

Public Member Functions

 FrTOCSimData ()
 Default constructor.
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
const MapSim_type & GetSim () const
 Return all channels. More...
 
MapSim_type::const_iterator GetSim (const std::string &Name) const
 Return the indexed data for a named channel. More...
 
MapSim_type::const_iterator GetSim (INT_4U index) const
 Return the indexed data for a named channel. More...
 
void QuerySim (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSimData being written. More...
 
const FrTOCSimDataoperator= (const Previous::FrTOCSimData &Source)
 asignment operator More...
 
bool operator== (const FrTOCSimData &RHS) const
 equality operator More...
 
 FrTOCSimData ()
 Default constructor.
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
const MapSim_type & GetSim () const
 Return all channels. More...
 
MapSim_type::const_iterator GetSim (const std::string &Name) const
 Return the indexed data for a named channel. More...
 
MapSim_type::const_iterator GetSim (INT_4U index) const
 Return the indexed data for a named channel. More...
 
void QuerySim (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSimData being written. More...
 
const FrTOCSimDataoperator= (const Previous::FrTOCSimData &Source)
 asignment operator More...
 
bool operator== (const FrTOCSimData &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

 FrTOCSimData (Common::IStream &Stream, INT_4U FrameCount)
 Stream constructor. More...
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
 FrTOCSimData (Common::IStream &Stream, INT_4U FrameCount)
 Stream constructor. More...
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 

Detailed Description

Indexed elements of the FrSimData structure.

Constructor & Destructor Documentation

◆ FrTOCSimData() [1/2]

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

◆ FrTOCSimData() [2/2]

FrameCPP::Version_8::FrTOCSimData::FrTOCSimData ( 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_8::FrTOCSimData::Bytes ( const Common::StreamBase &  Stream) const
inline

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

◆ Bytes() [2/2]

Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCSimData::Bytes ( const Common::StreamBase &  Stream) const

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

◆ Description() [1/2]

template<typename SE >
void FrameCPP::Version_8::FrTOCSimData::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::FrTOCSimData::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.

◆ forEach() [1/2]

void FrameCPP::Version_8::FrTOCSimData::forEach ( Common::FrTOC::query_info_type  Info,
Common::FrTOC::FunctionBase &  Action 
) const
protected

Iterate over contents.

Parameters
[in]InfoSpecifies the type of information to be searched.
[in]ActionAction to be taken for each piece of information found.

This method allows for iterting over each element of information and allows the caller to gather information about each element.

◆ forEach() [2/2]

void FrameCPP::Version_8::FrTOCSimData::forEach ( Common::FrTOC::query_info_type  Info,
Common::FrTOC::FunctionBase &  Action 
) const
protected

Iterate over contents.

Parameters
[in]InfoSpecifies the type of information to be searched.
[in]ActionAction to be taken for each piece of information found.

◆ GetSim() [1/6]

const FrTOCSimData::MapSim_type & FrameCPP::Version_8::FrTOCSimData::GetSim ( ) const
inline

Return all channels.

Returns
Constant container to the indexed FrSimData elements.

◆ GetSim() [2/6]

const MapSim_type& FrameCPP::Version_8::FrTOCSimData::GetSim ( ) const

Return all channels.

Returns
Constant container to the indexed FrSimData elements.

◆ GetSim() [3/6]

FrTOCSimData::MapSim_type::const_iterator FrameCPP::Version_8::FrTOCSimData::GetSim ( const std::string &  Name) const

Return the indexed data for a named channel.

Parameters
[in]NameThe name of the channel.
Returns
Constant iterator to the indexed FrSimData element.

◆ GetSim() [4/6]

MapSim_type::const_iterator FrameCPP::Version_8::FrTOCSimData::GetSim ( const std::string &  Name) const

Return the indexed data for a named channel.

Parameters
[in]NameThe name of the channel.
Returns
Constant iterator to the indexed FrSimData element.

◆ GetSim() [5/6]

FrTOCSimData::MapSim_type::const_iterator FrameCPP::Version_8::FrTOCSimData::GetSim ( INT_4U  index) const

Return the indexed data for a named channel.

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

◆ GetSim() [6/6]

MapSim_type::const_iterator FrameCPP::Version_8::FrTOCSimData::GetSim ( INT_4U  index) const

Return the indexed data for a named channel.

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

◆ operator=() [1/2]

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

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator=() [2/2]

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

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator==() [1/2]

bool FrameCPP::Version_8::FrTOCSimData::operator== ( const FrTOCSimData 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::FrTOCSimData::operator== ( const FrTOCSimData 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.

◆ QuerySim() [1/2]

void FrameCPP::Version_8::FrTOCSimData::QuerySim ( const Common::TOCInfo &  Info,
INT_4U  FrameOffset,
INT_8U  Position 
)

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

◆ QuerySim() [2/2]

void FrameCPP::Version_8::FrTOCSimData::QuerySim ( const Common::TOCInfo &  Info,
INT_4U  FrameOffset,
INT_8U  Position 
)

Gather TOC info for FrSimData 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::FrTOCSimData::write ( Common::OStream &  Stream) const
protected

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::FrTOCSimData::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: