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

#include <FrTOCAdcData.hh>

Inheritance diagram for FrameCPP::v9::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
 Container of indexed FrAdcData elements.
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
 Container of indexed FrAdcData elements.

Public Member Functions

const MapADC_typeGetADC () const
 Return all channels.
MapADC_type::const_iterator GetADC (const std::string &Name) const
 Return the indexed data for a named channel.
MapADC_type::const_iterator GetADC (INT_4U Channel) const
 Return the indexed data for an indexed channel.
const key_container_typeGetKeys () const
 Retrieve the keys.
bool operator== (const FrTOCAdcData &RHS) const
 equality operator
const MapADC_typeGetADC () const
 Return all channels.
MapADC_type::const_iterator GetADC (const std::string &Name) const
 Return the indexed data for a named channel.
MapADC_type::const_iterator GetADC (INT_4U Channel) const
 Return the indexed data for an indexed channel.
const key_container_typeGetKeys () const
 Retrieve the keys.
bool operator== (const FrTOCAdcData &RHS) const
 equality operator

Protected Member Functions

MapADC_typegetADC ()
MapADC_type::iterator getADC (const std::string &Channel)
MapADC_type::iterator getADC (INT_4U Channel)
MapADC_typegetADC ()
MapADC_type::iterator getADC (const std::string &Channel)
MapADC_type::iterator getADC (INT_4U Channel)

Protected Attributes

key_container_type m_keys
MapADC_type m_info

Member Typedef Documentation

◆ channel_id_type [1/2]

◆ channel_id_type [2/2]

◆ group_id_type [1/2]

◆ group_id_type [2/2]

◆ key_container_type [1/2]

◆ key_container_type [2/2]

◆ MapADC_type [1/2]

Container of indexed FrAdcData elements.

This structure is ordered by the name of the FrAdcData channel name. There is one element for each channel of indexed data.

◆ MapADC_type [2/2]

Container of indexed FrAdcData elements.

This structure is ordered by the name of the FrAdcData channel name. There is one element for each channel of indexed data.

◆ nadc_type [1/2]

◆ nadc_type [2/2]

◆ name_type [1/2]

◆ name_type [2/2]

◆ position_type [1/2]

◆ position_type [2/2]

Member Function Documentation

◆ GetADC() [1/6]

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

Return all channels.

Returns
Constant container to the indexed FrAdcData elements.

◆ GetADC() [2/6]

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

Return all channels.

Returns
Constant container to the indexed FrAdcData elements.

◆ GetADC() [3/6]

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

Return the indexed data for a named channel.

Parameters
[in]ChannelThe name of the channel.
Returns
Constant iterator to the indexed FrAdcData element.

◆ GetADC() [4/6]

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

Return the indexed data for a named channel.

Parameters
[in]ChannelThe name of the channel.
Returns
Constant iterator to the indexed FrAdcData element.

◆ GetADC() [5/6]

FrTOCAdcData::MapADC_type::const_iterator FrameCPP::v9::FrTOCAdcData::GetADC ( INT_4U Channel) const
inline

Return the indexed data for an indexed channel.

Parameters
[in]ChannelThe numeric offset of the channel.
Returns
Constant iterator to the indexed FrAdcData element.

◆ GetADC() [6/6]

MapADC_type::const_iterator FrameCPP::v9::FrTOCAdcData::GetADC ( INT_4U Channel) const

Return the indexed data for an indexed channel.

Parameters
[in]ChannelThe numeric offset of the channel.
Returns
Constant iterator to the indexed FrAdcData element.

◆ getADC() [1/6]

MapADC_type & FrameCPP::v9::FrTOCAdcData::getADC ( )
inlineprotected

◆ getADC() [2/6]

MapADC_type & FrameCPP::v9::FrTOCAdcData::getADC ( )
inlineprotected

◆ getADC() [3/6]

MapADC_type::iterator FrameCPP::v9::FrTOCAdcData::getADC ( const std::string & Channel)
inlineprotected

◆ getADC() [4/6]

MapADC_type::iterator FrameCPP::v9::FrTOCAdcData::getADC ( const std::string & Channel)
inlineprotected

◆ getADC() [5/6]

MapADC_type::iterator FrameCPP::v9::FrTOCAdcData::getADC ( INT_4U Channel)
inlineprotected

◆ getADC() [6/6]

MapADC_type::iterator FrameCPP::v9::FrTOCAdcData::getADC ( INT_4U Channel)
inlineprotected

◆ GetKeys() [1/2]

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

Retrieve the keys.

Returns
Constant container of keys.

◆ GetKeys() [2/2]

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

Retrieve the keys.

Returns
Constant container of keys.

◆ operator==() [1/2]

bool FrameCPP::v9::FrTOCAdcData::operator== ( const FrTOCAdcData & 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.

◆ operator==() [2/2]

bool FrameCPP::v9::FrTOCAdcData::operator== ( const FrTOCAdcData & 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.

Member Data Documentation

◆ m_info

MapADC_type FrameCPP::v9::FrTOCAdcData::m_info
protected

◆ m_keys

key_container_type FrameCPP::v9::FrTOCAdcData::m_keys
protected

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/storage/data/v9/FrTOCAdcData.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/storage/data/v9/FrTOCAdcData.hh