ldas-tools-framecpp  2.6.2
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_6::FrTOCAdcData Class Reference

#include <FrTOCAdcData.hh>

Inheritance diagram for FrameCPP::Version_6::FrTOCAdcData:
FrameCPP::Version_6::FrTOC

Classes

struct  adc_info_type
 

Public Types

typedef INT_4U nadc_type
 
typedef STRING name_type
 
typedef INT_4U channel_id_type
 
typedef INT_4U group_id_type
 
typedef INT_8U position_type
 
typedef std::vector< name_typekey_container_type
 
typedef std::map< name_type, adc_info_typeMapADC_type
 

Public Member Functions

 FrTOCAdcData ()
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 
const MapADC_typeGetADC () const
 
MapADC_type::const_iterator GetADC (const std::string &Name) const
 
MapADC_type::const_iterator GetADC (INT_4U index) const
 
const key_container_typeGetKeys () const
 Retrieve the keys. More...
 
void QueryAdc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCAdcData &RHS) const
 

Static Public Member Functions

template<typename SE >
static void Description (Common::Description &Desc)
 

Protected Member Functions

 FrTOCAdcData (Common::IStream &Stream, INT_4U FrameCount)
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void cachePositions (istream_type &Stream)
 
void seekPositions (istream_type &Stream, channel_id_type Channel)
 
void seekPositions (istream_type &Stream, const std::string &Channel)
 
void write (Common::OStream &Stream) const
 

Protected Attributes

position_type m_positions_start
 
key_container_type m_keys
 
MapADC_type m_info
 

Member Typedef Documentation

◆ channel_id_type

◆ group_id_type

◆ key_container_type

◆ MapADC_type

◆ nadc_type

◆ name_type

◆ position_type

Constructor & Destructor Documentation

◆ FrTOCAdcData() [1/2]

FrameCPP::Version_6::FrTOCAdcData::FrTOCAdcData ( )

◆ FrTOCAdcData() [2/2]

FrameCPP::Version_6::FrTOCAdcData::FrTOCAdcData ( Common::IStream Stream,
INT_4U  FrameCount 
)
protected

Member Function Documentation

◆ Bytes()

Common::FrameSpec::size_type FrameCPP::Version_6::FrTOCAdcData::Bytes ( const Common::StreamBase Stream) const
inline

◆ cachePositions()

void FrameCPP::Version_6::FrTOCAdcData::cachePositions ( istream_type Stream)
inlineprotected

◆ Description()

template<typename SE >
void FrameCPP::Version_6::FrTOCAdcData::Description ( Common::Description Desc)
static

◆ forEach()

void FrameCPP::Version_6::FrTOCAdcData::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.

◆ GetADC() [1/3]

const FrTOCAdcData::MapADC_type & FrameCPP::Version_6::FrTOCAdcData::GetADC ( ) const
inline

◆ GetADC() [2/3]

FrTOCAdcData::MapADC_type::const_iterator FrameCPP::Version_6::FrTOCAdcData::GetADC ( const std::string &  Name) const

◆ GetADC() [3/3]

FrTOCAdcData::MapADC_type::const_iterator FrameCPP::Version_6::FrTOCAdcData::GetADC ( INT_4U  index) const

◆ GetKeys()

const FrTOCAdcData::key_container_type & FrameCPP::Version_6::FrTOCAdcData::GetKeys ( ) const
inline

Retrieve the keys.

Returns
Constant container of keys.

◆ operator==()

bool FrameCPP::Version_6::FrTOCAdcData::operator== ( const FrTOCAdcData RHS) const

◆ QueryAdc()

void FrameCPP::Version_6::FrTOCAdcData::QueryAdc ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)

◆ seekPositions() [1/2]

void FrameCPP::Version_6::FrTOCAdcData::seekPositions ( istream_type Stream,
channel_id_type  Channel 
)
inlineprotected

◆ seekPositions() [2/2]

void FrameCPP::Version_6::FrTOCAdcData::seekPositions ( istream_type Stream,
const std::string &  Channel 
)
inlineprotected

◆ write()

void FrameCPP::Version_6::FrTOCAdcData::write ( Common::OStream Stream) const
protected

Member Data Documentation

◆ m_info

MapADC_type FrameCPP::Version_6::FrTOCAdcData::m_info
protected

◆ m_keys

key_container_type FrameCPP::Version_6::FrTOCAdcData::m_keys
protected

◆ m_positions_start

position_type FrameCPP::Version_6::FrTOCAdcData::m_positions_start
protected

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