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 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:
FrameCPP::Version_8::FrTOC

Public Types

typedef INT_4U nsim_type
 
typedef STRING name_type
 
typedef INT_8U position_type
 
typedef std::vector
< position_type
sim_info_type
 
typedef std::map< name_type,
sim_info_type
MapSim_type
 

Public Member Functions

 FrTOCSimData ()
 Default constructor. More...
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
const MapSim_typeGetSim () 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...
 

Protected Types

typedef std::vector< name_typekey_container_type
 

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

Protected Attributes

key_container_type m_keys
 
MapSim_type m_info
 

Detailed Description

Indexed elements of the FrSimData structure.

Member Typedef Documentation

Constructor & Destructor Documentation

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

Default constructor.

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

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

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

Return all channels.

Returns
Constant container to the indexed FrSimData elements.
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.
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.
const FrTOCSimData & FrameCPP::Version_8::FrTOCSimData::operator= ( const Previous::FrTOCSimData &  Source)

asignment operator

Parameters
[in]SourceThe source to be copied.
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.
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.
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

MapSim_type FrameCPP::Version_8::FrTOCSimData::m_info
protected
key_container_type FrameCPP::Version_8::FrTOCSimData::m_keys
protected

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