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

#include <FrTOCAdcData.hh>

Inheritance diagram for FrameCPP::Version_4::FrTOCAdcData:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_4::FrTOCAdcData:
Collaboration graph
[legend]

Classes

struct  adc_info_type

Public Types

typedef std::string name_type
typedef INT_4U nADC_type
typedef INT_4U channelID_type
typedef INT_4U groupID_type
typedef std::map< name_type, adc_info_type > MapADC_type
typedef std::string name_type
typedef INT_4U nADC_type
typedef INT_4U channelID_type
typedef INT_4U groupID_type
typedef std::map< name_type, adc_info_type > MapADC_type
typedef INT_8U position_type
typedef INT_8U position_type

Public Member Functions

 FrTOCAdcData ()
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
const MapADC_type & GetADC () const
MapADC_type::const_iterator GetADC (const std::string &Name) const
MapADC_type::const_iterator GetADC (INT_4U index) const
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_type & GetADC () const
MapADC_type::const_iterator GetADC (const std::string &Name) const
MapADC_type::const_iterator GetADC (INT_4U index) const
void QueryADC (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
bool operator== (const FrTOCAdcData &RHS) const

Static Public Member Functions

static void Description (Common::Description &Desc)
static void Description (Common::Description &Desc)

Protected Types

typedef std::vector< name_type > key_container_type
typedef std::vector< name_type > key_container_type

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, channelID_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, channelID_type Channel)
void seekPositions (istream_type &Stream, const std::string &Channel)
void write (Common::OStream &Stream) const

Protected Attributes

key_container_type m_keys
MapADC_type m_adc_info

Private Types

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

Private Member Functions

MapADC_type & getADC ()
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_type & getADC ()
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

◆ channelID_type [1/2]

typedef INT_4U FrameCPP::Version_4::FrTOCAdcData::channelID_type

◆ channelID_type [2/2]

typedef INT_4U FrameCPP::Version_4::FrTOCAdcData::channelID_type

◆ groupID_type [1/2]

typedef INT_4U FrameCPP::Version_4::FrTOCAdcData::groupID_type

◆ groupID_type [2/2]

typedef INT_4U FrameCPP::Version_4::FrTOCAdcData::groupID_type

◆ key_container_type [1/2]

typedef std::vector< name_type > FrameCPP::Version_4::FrTOCAdcData::key_container_type
protected

◆ key_container_type [2/2]

typedef std::vector< name_type > FrameCPP::Version_4::FrTOCAdcData::key_container_type
protected

◆ MapADC_type [1/2]

typedef std::map< name_type, adc_info_type > FrameCPP::Version_4::FrTOCAdcData::MapADC_type

◆ MapADC_type [2/2]

typedef std::map< name_type, adc_info_type > FrameCPP::Version_4::FrTOCAdcData::MapADC_type

◆ nADC_type [1/2]

typedef INT_4U FrameCPP::Version_4::FrTOCAdcData::nADC_type

◆ nADC_type [2/2]

typedef INT_4U FrameCPP::Version_4::FrTOCAdcData::nADC_type

◆ name_type [1/2]

typedef std::string FrameCPP::Version_4::FrTOCAdcData::name_type

◆ name_type [2/2]

typedef std::string FrameCPP::Version_4::FrTOCAdcData::name_type

◆ position_type [1/2]

typedef INT_8U FrameCPP::Version_4::FrTOCTypes::position_type
inherited

◆ position_type [2/2]

typedef INT_8U FrameCPP::Version_4::FrTOCTypes::position_type
inherited

◆ positions_cache_type [1/2]

typedef std::vector< position_type > FrameCPP::Version_4::FrTOCAdcData::positions_cache_type
private

◆ positions_cache_type [2/2]

typedef std::vector< position_type > FrameCPP::Version_4::FrTOCAdcData::positions_cache_type
private

◆ reverse_lookup_type [1/2]

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

◆ reverse_lookup_type [2/2]

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

Constructor & Destructor Documentation

◆ FrTOCAdcData() [1/4]

FrameCPP::Version_4::FrTOCAdcData::FrTOCAdcData ( )
inline

◆ FrTOCAdcData() [2/4]

FrameCPP::Version_4::FrTOCAdcData::FrTOCAdcData ( Common::IStream & Stream,
INT_4U FrameCount )
inlineprotected

◆ FrTOCAdcData() [3/4]

FrameCPP::Version_4::FrTOCAdcData::FrTOCAdcData ( )

◆ FrTOCAdcData() [4/4]

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

Member Function Documentation

◆ Bytes() [1/2]

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

◆ Bytes() [2/2]

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

◆ cachePositions() [1/2]

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

◆ cachePositions() [2/2]

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

◆ Description() [1/2]

void FrameCPP::Version_4::FrTOCAdcData::Description ( Common::Description & Desc)
static

◆ Description() [2/2]

void FrameCPP::Version_4::FrTOCAdcData::Description ( Common::Description & Desc)
static

◆ forEach() [1/2]

void FrameCPP::Version_4::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_4::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_4::FrTOCAdcData::GetADC ( ) const
inline

◆ GetADC() [2/6]

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

◆ GetADC() [3/6]

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

◆ GetADC() [4/6]

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

◆ GetADC() [5/6]

FrTOCAdcData::MapADC_type::const_iterator FrameCPP::Version_4::FrTOCAdcData::GetADC ( INT_4U index) const
inline

◆ GetADC() [6/6]

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

◆ getADC() [1/6]

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

◆ getADC() [2/6]

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

◆ getADC() [3/6]

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

◆ getADC() [4/6]

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

◆ getADC() [5/6]

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

◆ getADC() [6/6]

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

◆ operator==() [1/2]

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

◆ operator==() [2/2]

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

◆ QueryADC() [1/2]

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

◆ QueryADC() [2/2]

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

◆ reverse_lookup() [1/2]

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

◆ reverse_lookup() [2/2]

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

◆ seekPositions() [1/4]

void FrameCPP::Version_4::FrTOCAdcData::seekPositions ( istream_type & Stream,
channelID_type Channel )
inlineprotected

◆ seekPositions() [2/4]

void FrameCPP::Version_4::FrTOCAdcData::seekPositions ( istream_type & Stream,
channelID_type Channel )
protected

◆ seekPositions() [3/4]

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

◆ seekPositions() [4/4]

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

◆ write() [1/2]

void FrameCPP::Version_4::FrTOCAdcData::write ( Common::OStream & Stream) const
inlineprotected

◆ write() [2/2]

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

Member Data Documentation

◆ m_adc_info

MapADC_type FrameCPP::Version_4::FrTOCAdcData::m_adc_info
protected

◆ m_keys

key_container_type FrameCPP::Version_4::FrTOCAdcData::m_keys
protected

◆ positions_cache

positions_cache_type FrameCPP::Version_4::FrTOCAdcData::positions_cache
private

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

◆ positions_cache_offset

position_type FrameCPP::Version_4::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_4::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:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version4/FrTOCAdcData.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version4/FrTOCAdcData.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version4/FrTOCAdcData.cc