ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_6::FrTOCAdcData Class Reference

#include <FrTOCAdcData.hh>

Inheritance diagram for FrameCPP::Version_6::FrTOCAdcData:

Classes

struct  adc_info_type
 

Public Types

typedef INT_4U nadc_type
 
typedef std::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.
 
void QueryAdc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCAdcData &RHS) const
 
 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.
 
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)
 
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.
 
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
 
 FrTOCAdcData (Common::IStream &Stream, INT_4U FrameCount)
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
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
 

Private Types

typedef LDASTools::AL::unordered_map< std::string, INT_4U > reverse_lookup_type
 
typedef std::vector< position_typepositions_cache_type
 

Private Member Functions

MapADC_typegetADC ()
 
MapADC_type::iterator getADC (const std::string &Name)
 
MapADC_type::iterator getADC (INT_4U index)
 
reverse_lookup_type::mapped_type reverse_lookup (const reverse_lookup_type::key_type &key) const
 
MapADC_typegetADC ()
 
MapADC_type::iterator getADC (const std::string &Name)
 
MapADC_type::iterator getADC (INT_4U index)
 
reverse_lookup_type::mapped_type reverse_lookup (const reverse_lookup_type::key_type &key) const
 

Private Attributes

positions_cache_type positions_cache
 
position_type positions_cache_offset
 
reverse_lookup_type reverse_lookup_
 

Member Typedef Documentation

◆ channel_id_type

◆ group_id_type

◆ key_container_type

◆ MapADC_type

◆ nadc_type

◆ name_type

◆ position_type

◆ positions_cache_type

◆ reverse_lookup_type

typedef LDASTools::AL::unordered_map< std::string, INT_4U > FrameCPP::Version_6::FrTOCAdcData::reverse_lookup_type
private

Constructor & Destructor Documentation

◆ FrTOCAdcData() [1/4]

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

◆ FrTOCAdcData() [2/4]

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

◆ FrTOCAdcData() [3/4]

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

◆ FrTOCAdcData() [4/4]

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

Member Function Documentation

◆ Bytes() [1/2]

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

◆ Bytes() [2/2]

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

◆ cachePositions() [1/2]

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

◆ cachePositions() [2/2]

void FrameCPP::Version_6::FrTOCAdcData::cachePositions ( istream_type & Stream)
protected

◆ Description() [1/2]

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

◆ Description() [2/2]

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

◆ forEach() [1/2]

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.

◆ forEach() [2/2]

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.

◆ GetADC() [1/6]

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

◆ GetADC() [2/6]

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

◆ GetADC() [3/6]

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

◆ GetADC() [4/6]

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

◆ GetADC() [5/6]

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

◆ GetADC() [6/6]

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

◆ getADC() [1/6]

FrTOCAdcData::MapADC_type & FrameCPP::Version_6::FrTOCAdcData::getADC ( )
inlineprivate

◆ getADC() [2/6]

MapADC_type & FrameCPP::Version_6::FrTOCAdcData::getADC ( )
private

◆ getADC() [3/6]

FrTOCAdcData::MapADC_type::iterator FrameCPP::Version_6::FrTOCAdcData::getADC ( const std::string & Name)
inlineprivate

◆ getADC() [4/6]

MapADC_type::iterator FrameCPP::Version_6::FrTOCAdcData::getADC ( const std::string & Name)
private

◆ getADC() [5/6]

FrTOCAdcData::MapADC_type::iterator FrameCPP::Version_6::FrTOCAdcData::getADC ( INT_4U index)
inlineprivate

◆ getADC() [6/6]

MapADC_type::iterator FrameCPP::Version_6::FrTOCAdcData::getADC ( INT_4U index)
private

◆ GetKeys() [1/2]

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

Retrieve the keys.

Returns
Constant container of keys.

◆ GetKeys() [2/2]

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

Retrieve the keys.

Returns
Constant container of keys.

◆ operator==() [1/2]

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

◆ operator==() [2/2]

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

◆ QueryAdc() [1/2]

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

◆ QueryAdc() [2/2]

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

◆ reverse_lookup() [1/2]

FrTOCAdcData::reverse_lookup_type::mapped_type FrameCPP::Version_6::FrTOCAdcData::reverse_lookup ( const reverse_lookup_type::key_type & key) const
inlineprivate

◆ reverse_lookup() [2/2]

reverse_lookup_type::mapped_type FrameCPP::Version_6::FrTOCAdcData::reverse_lookup ( const reverse_lookup_type::key_type & key) const
private

◆ seekPositions() [1/4]

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

◆ seekPositions() [2/4]

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

◆ seekPositions() [3/4]

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

◆ seekPositions() [4/4]

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

◆ write() [1/2]

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

◆ write() [2/2]

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

◆ positions_cache

positions_cache_type FrameCPP::Version_6::FrTOCAdcData::positions_cache
private

A cache of the positions of the FrAdcData structures within the stream.

◆ positions_cache_offset

position_type FrameCPP::Version_6::FrTOCAdcData::positions_cache_offset
private

The number of bytes from the end of the stream where the array containing the FrAdcData offsets.

◆ reverse_lookup_

reverse_lookup_type FrameCPP::Version_6::FrTOCAdcData::reverse_lookup_
mutableprivate

Provide means where a channel index can be mapped to a channel name


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