ldas-tools-framecpp  2.8.1
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | 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]
Collaboration diagram for FrameCPP::Version_8::FrTOCSimData:
Collaboration graph
[legend]

Public Types

typedef INT_4U nsim_type
 
typedef INT_4U nsim_type
 
typedef INT_4U nsim_type
 
typedef STRING name_type
 
typedef STRING name_type
 
typedef STRING name_type
 
typedef INT_8U position_type
 
typedef INT_8U position_type
 
typedef INT_8U position_type
 
typedef std::vector< position_typesim_info_type
 
typedef std::vector< position_typesim_info_type
 
typedef std::vector< position_typesim_info_type
 
typedef std::map< name_type, sim_info_typeMapSim_type
 
typedef std::map< name_type, sim_info_typeMapSim_type
 
typedef std::map< name_type, sim_info_typeMapSim_type
 

Public Member Functions

 FrTOCSimData ()=default
 Default constructor. More...
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. 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...
 
void Load (istream_type &Stream, INT_4U FrameCount)
 Read contents from stream. More...
 
const MapSim_typeGetSim () const
 Return all channels. More...
 
MapSim_type::const_iterator GetSim (const std::string &Channel) const
 Return the indexed data for a named channel. More...
 
MapSim_type::const_iterator GetSim (INT_4U Channel) const
 Return the indexed data for a named channel. More...
 
const MapSim_typeGetSim () const
 Return all channels. More...
 
MapSim_type::const_iterator GetSim (const std::string &Channel) const
 Return the indexed data for a named channel. More...
 
MapSim_type::const_iterator GetSim (INT_4U Channel) const
 Return the indexed data for a named channel. More...
 
const MapSim_typeGetSim () const
 Return all channels. More...
 
MapSim_type::const_iterator GetSim (const std::string &Channel) const
 Return the indexed data for a named channel. More...
 
MapSim_type::const_iterator GetSim (INT_4U Channel) const
 Return the indexed data for a named channel. More...
 

Static Public Member Functions

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

Protected Types

typedef std::vector< name_typekey_container_type
 
typedef std::vector< name_typekey_container_type
 
typedef std::vector< name_typekey_container_type
 

Protected Member Functions

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

Protected Attributes

key_container_type m_keys
 
MapSim_type m_info
 

Detailed Description

Indexed elements of the FrSimData structure.

Member Typedef Documentation

◆ key_container_type [1/3]

◆ key_container_type [2/3]

◆ key_container_type [3/3]

◆ MapSim_type [1/3]

◆ MapSim_type [2/3]

◆ MapSim_type [3/3]

◆ name_type [1/3]

◆ name_type [2/3]

◆ name_type [3/3]

◆ nsim_type [1/3]

◆ nsim_type [2/3]

◆ nsim_type [3/3]

◆ position_type [1/3]

◆ position_type [2/3]

◆ position_type [3/3]

◆ sim_info_type [1/3]

◆ sim_info_type [2/3]

◆ sim_info_type [3/3]

Constructor & Destructor Documentation

◆ FrTOCSimData()

FrameCPP::Version_8::FrTOCSimData::FrTOCSimData ( )
default

Default constructor.

Member Function Documentation

◆ Bytes()

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.

◆ Description()

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.

◆ forEach()

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.

◆ GetSim() [1/9]

const MapSim_type& FrameCPP::Version_8::FrTOCImpl::FrTOCSimDataData::GetSim ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrSimData elements.

◆ GetSim() [2/9]

const MapSim_type& FrameCPP::Version_8::FrTOCImpl::FrTOCSimDataData::GetSim ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrSimData elements.

◆ GetSim() [3/9]

const MapSim_type& FrameCPP::Version_8::FrTOCImpl::FrTOCSimDataData::GetSim ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrSimData elements.

◆ GetSim() [4/9]

MapSim_type::const_iterator FrameCPP::Version_8::FrTOCImpl::FrTOCSimDataData::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/9]

MapSim_type::const_iterator FrameCPP::Version_8::FrTOCImpl::FrTOCSimDataData::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() [6/9]

MapSim_type::const_iterator FrameCPP::Version_8::FrTOCImpl::FrTOCSimDataData::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() [7/9]

MapSim_type::const_iterator FrameCPP::Version_8::FrTOCImpl::FrTOCSimDataData::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() [8/9]

MapSim_type::const_iterator FrameCPP::Version_8::FrTOCImpl::FrTOCSimDataData::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() [9/9]

MapSim_type::const_iterator FrameCPP::Version_8::FrTOCImpl::FrTOCSimDataData::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_8::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_8::FrTOCSimData::operator= ( const Previous::FrTOCSimData &  Source)

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator==()

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()

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()

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.

Member Data Documentation

◆ m_info

MapSim_type FrameCPP::Version_8::FrTOCImpl::FrTOCSimDataData::m_info
protectedinherited

◆ m_keys

key_container_type FrameCPP::Version_8::FrTOCImpl::FrTOCSimDataData::m_keys
protectedinherited

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