ldas-tools-framecpp  2.7.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
FrameCPP::Version_8::FrTOCAdcData Class Reference

Indexed elements of the FrAdcData structure. More...

#include <FrTOCAdcData.hh>

Inheritance diagram for FrameCPP::Version_8::FrTOCAdcData:
Inheritance graph
[legend]

Public Types

typedef Previous::FrTOCAdcData::nadc_type nadc_type
 
typedef Previous::FrTOCAdcData::name_type name_type
 
typedef Previous::FrTOCAdcData::channel_id_type channel_id_type
 
typedef Previous::FrTOCAdcData::group_id_type group_id_type
 
typedef Previous::FrTOCAdcData::position_type position_type
 
typedef Previous::FrTOCAdcData::adc_info_type adc_info_type
 
typedef std::vector< name_type > key_container_type
 
typedef std::map< name_type, adc_info_type > MapADC_type
 Container of indexed FrAdcData elements. More...
 
typedef Previous::FrTOCAdcData::nadc_type nadc_type
 
typedef Previous::FrTOCAdcData::name_type name_type
 
typedef Previous::FrTOCAdcData::channel_id_type channel_id_type
 
typedef Previous::FrTOCAdcData::group_id_type group_id_type
 
typedef Previous::FrTOCAdcData::position_type position_type
 
typedef Previous::FrTOCAdcData::adc_info_type adc_info_type
 
typedef std::vector< name_type > key_container_type
 
typedef std::map< name_type, adc_info_type > MapADC_type
 Container of indexed FrAdcData elements. More...
 

Public Member Functions

 FrTOCAdcData ()
 Default constructor. More...
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
const MapADC_type & GetADC () const
 Return all channels. More...
 
MapADC_type::const_iterator GetADC (const std::string &Name) const
 Return the indexed data for a named channel. More...
 
MapADC_type::const_iterator GetADC (INT_4U index) const
 Return the indexed data for an indexed channel. More...
 
const key_container_type & GetKeys () const
 Retrieve the keys. More...
 
void QueryAdc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrAdcData being written. More...
 
const FrTOCAdcData & operator= (const Previous::FrTOCAdcData &Source)
 asignment operator More...
 
bool operator== (const FrTOCAdcData &RHS) const
 equality operator More...
 
 FrTOCAdcData ()
 Default constructor. More...
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
const MapADC_type & GetADC () const
 Return all channels. More...
 
MapADC_type::const_iterator GetADC (const std::string &Name) const
 Return the indexed data for a named channel. More...
 
MapADC_type::const_iterator GetADC (INT_4U index) const
 Return the indexed data for an indexed channel. More...
 
const key_container_type & GetKeys () const
 Retrieve the keys. More...
 
void QueryAdc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrAdcData being written. More...
 
const FrTOCAdcData & operator= (const Previous::FrTOCAdcData &Source)
 asignment operator More...
 
bool operator== (const FrTOCAdcData &RHS) const
 equality operator More...
 

Static Public Member Functions

template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure. More...
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure. More...
 

Public Attributes

position_type m_positions_start
 

Protected Member Functions

 FrTOCAdcData (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 cachePositions (istream_type &Stream)
 Cache where the positions of the Adc channels. More...
 
void seekPositions (istream_type &Stream, channel_id_type Channel)
 Advance to the specified Adc channel. More...
 
void seekPositions (istream_type &Stream, const std::string &Channel)
 Advance to the specified Adc channel. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
 FrTOCAdcData (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 cachePositions (istream_type &Stream)
 Cache where the positions of the Adc channels. More...
 
void seekPositions (istream_type &Stream, channel_id_type Channel)
 Advance to the specified Adc channel. More...
 
void seekPositions (istream_type &Stream, const std::string &Channel)
 Advance to the specified Adc channel. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 

Protected Attributes

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

Detailed Description

Indexed elements of the FrAdcData structure.

Member Typedef Documentation

◆ adc_info_type [1/2]

typedef Previous::FrTOCAdcData::adc_info_type FrameCPP::Version_8::FrTOCAdcData::adc_info_type

◆ adc_info_type [2/2]

typedef Previous::FrTOCAdcData::adc_info_type FrameCPP::Version_8::FrTOCAdcData::adc_info_type

◆ channel_id_type [1/2]

typedef Previous::FrTOCAdcData::channel_id_type FrameCPP::Version_8::FrTOCAdcData::channel_id_type

◆ channel_id_type [2/2]

typedef Previous::FrTOCAdcData::channel_id_type FrameCPP::Version_8::FrTOCAdcData::channel_id_type

◆ group_id_type [1/2]

typedef Previous::FrTOCAdcData::group_id_type FrameCPP::Version_8::FrTOCAdcData::group_id_type

◆ group_id_type [2/2]

typedef Previous::FrTOCAdcData::group_id_type FrameCPP::Version_8::FrTOCAdcData::group_id_type

◆ key_container_type [1/2]

typedef std::vector< name_type > FrameCPP::Version_8::FrTOCAdcData::key_container_type

◆ key_container_type [2/2]

typedef std::vector< name_type > FrameCPP::Version_8::FrTOCAdcData::key_container_type

◆ MapADC_type [1/2]

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

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]

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

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]

typedef Previous::FrTOCAdcData::nadc_type FrameCPP::Version_8::FrTOCAdcData::nadc_type

◆ nadc_type [2/2]

typedef Previous::FrTOCAdcData::nadc_type FrameCPP::Version_8::FrTOCAdcData::nadc_type

◆ name_type [1/2]

typedef Previous::FrTOCAdcData::name_type FrameCPP::Version_8::FrTOCAdcData::name_type

◆ name_type [2/2]

typedef Previous::FrTOCAdcData::name_type FrameCPP::Version_8::FrTOCAdcData::name_type

◆ position_type [1/2]

typedef Previous::FrTOCAdcData::position_type FrameCPP::Version_8::FrTOCAdcData::position_type

◆ position_type [2/2]

typedef Previous::FrTOCAdcData::position_type FrameCPP::Version_8::FrTOCAdcData::position_type

◆ positions_cache_type [1/2]

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

◆ positions_cache_type [2/2]

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

◆ reverse_lookup_type [1/2]

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

◆ reverse_lookup_type [2/2]

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

Constructor & Destructor Documentation

◆ FrTOCAdcData() [1/4]

FrameCPP::Version_8::FrTOCAdcData::FrTOCAdcData ( )

Default constructor.

◆ FrTOCAdcData() [2/4]

FrameCPP::Version_8::FrTOCAdcData::FrTOCAdcData ( 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.

◆ FrTOCAdcData() [3/4]

FrameCPP::Version_8::FrTOCAdcData::FrTOCAdcData ( )

Default constructor.

◆ FrTOCAdcData() [4/4]

FrameCPP::Version_8::FrTOCAdcData::FrTOCAdcData ( 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

◆ Bytes() [1/2]

Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCAdcData::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.

◆ Bytes() [2/2]

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

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.

◆ cachePositions() [1/2]

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

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

◆ cachePositions() [2/2]

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

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

◆ Description() [1/2]

template<typename SE >
void FrameCPP::Version_8::FrTOCAdcData::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.

◆ Description() [2/2]

template<typename SE >
static void FrameCPP::Version_8::FrTOCAdcData::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.

◆ forEach() [1/2]

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

Return all channels.

Returns
Constant container to the indexed FrAdcData elements.

◆ GetADC() [2/6]

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

Return all channels.

Returns
Constant container to the indexed FrAdcData elements.

◆ GetADC() [3/6]

MapADC_type::const_iterator FrameCPP::Version_8::FrTOCAdcData::GetADC ( 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 FrAdcData element.

◆ GetADC() [4/6]

FrTOCAdcData::MapADC_type::const_iterator FrameCPP::Version_8::FrTOCAdcData::GetADC ( 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 FrAdcData element.

◆ GetADC() [5/6]

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

Return the indexed data for an indexed channel.

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

◆ GetADC() [6/6]

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

Return the indexed data for an indexed channel.

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

◆ getADC() [1/6]

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

◆ getADC() [2/6]

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

◆ getADC() [3/6]

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

◆ getADC() [4/6]

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

◆ getADC() [5/6]

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

◆ getADC() [6/6]

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

◆ GetKeys() [1/2]

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

Retrieve the keys.

Returns
Constant container of keys.

◆ GetKeys() [2/2]

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

Retrieve the keys.

Returns
Constant container of keys.

◆ operator=() [1/2]

const FrTOCAdcData& FrameCPP::Version_8::FrTOCAdcData::operator= ( const Previous::FrTOCAdcData &  Source)

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator=() [2/2]

const FrTOCAdcData & FrameCPP::Version_8::FrTOCAdcData::operator= ( const Previous::FrTOCAdcData &  Source)

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator==() [1/2]

bool FrameCPP::Version_8::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::Version_8::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.

◆ QueryAdc() [1/2]

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

Gather TOC info for FrAdcData 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.

◆ QueryAdc() [2/2]

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

Gather TOC info for FrAdcData 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.

◆ reverse_lookup() [1/2]

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

◆ reverse_lookup() [2/2]

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

◆ seekPositions() [1/4]

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

Advance to the specified Adc channel.

Parameters
[in,out]StreamThe Stream being read
[in]ChannelThe requested channel

◆ seekPositions() [2/4]

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

Advance to the specified Adc channel.

Parameters
[in,out]StreamThe Stream being read
[in]ChannelThe requested channel

◆ seekPositions() [3/4]

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

Advance to the specified Adc channel.

Parameters
[in,out]StreamThe Stream being read
[in]ChannelThe requested channel

◆ seekPositions() [4/4]

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

Advance to the specified Adc channel.

Parameters
[in,out]StreamThe Stream being read
[in]ChannelThe requested channel

◆ write() [1/2]

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

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ write() [2/2]

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

◆ m_info

MapADC_type FrameCPP::Version_8::FrTOCAdcData::m_info
protected

◆ m_keys

key_container_type FrameCPP::Version_8::FrTOCAdcData::m_keys
protected

◆ m_positions_start

position_type FrameCPP::Version_8::FrTOCAdcData::m_positions_start

◆ positions_cache

positions_cache_type FrameCPP::Version_8::FrTOCAdcData::positions_cache
private

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

◆ positions_cache_offset

position_type FrameCPP::Version_8::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_8::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:
Generated by   doxygen 1.8.14