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

Indexed elements of the FrSimData structure. More...

#include <FrTOCSimData.hh>

Public Member Functions

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

Protected Member Functions

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

Detailed Description

Indexed elements of the FrSimData structure.

Member Function Documentation

◆ Bytes()

Common::FrameSpec::size_type FrameCPP::Version_9::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.

◆ Description()

template<typename SE >
void FrameCPP::Version_9::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()

void FrameCPP::Version_9::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 MapSim_type & FrameCPP::v8::FrTOCSimData::GetSim ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrSimData elements.

◆ GetSim() [2/6]

const MapSim_type & FrameCPP::v8::FrTOCSimData::GetSim ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrSimData elements.

◆ GetSim() [3/6]

MapSim_type::const_iterator FrameCPP::v8::FrTOCSimData::GetSim ( 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 FrSimData element.

◆ GetSim() [4/6]

MapSim_type::const_iterator FrameCPP::v8::FrTOCSimData::GetSim ( 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 FrSimData element.

◆ GetSim() [5/6]

MapSim_type::const_iterator FrameCPP::v8::FrTOCSimData::GetSim ( 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 FrSimData element.

◆ GetSim() [6/6]

MapSim_type::const_iterator FrameCPP::v8::FrTOCSimData::GetSim ( 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 FrSimData element.

◆ Load()

void FrameCPP::Version_9::FrTOCSimData::Load ( istream_type & Stream,
INT_4U FrameCount )

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ operator=()

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

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator==()

bool FrameCPP::Version_9::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()

void FrameCPP::Version_9::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()

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