ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
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_9::FrTOCImpl::FrTOCAdcDataClassicIO Class Reference

#include <FrTOCAdcDataClassicIO.hh>

Inheritance diagram for FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO:
Collaboration graph
[legend]

Public Types

typedef INT_4U nadc_type
 
typedef INT_4U nadc_type
 
typedef std::string name_type
 
typedef std::string name_type
 
typedef INT_4U channel_id_type
 
typedef INT_4U channel_id_type
 
typedef INT_4U group_id_type
 
typedef INT_4U group_id_type
 
typedef INT_8U position_type
 
typedef INT_8U position_type
 
typedef std::vector< name_type > key_container_type
 
typedef std::vector< name_type > key_container_type
 
typedef std::map< name_type, adc_info_type > MapADC_type
 Container of indexed FrAdcData elements.
 
typedef std::map< name_type, adc_info_type > MapADC_type
 Container of indexed FrAdcData elements.
 

Public Member Functions

 FrTOCAdcDataClassicIO ()=default
 Default constructor.
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
void QueryAdc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrAdcData being written.
 
const FrTOCAdcDataClassicIO & operator= (const Previous::FrTOCImpl::FrTOCAdcDataClassicIO &Source)
 asignment operator
 
FrTOCAdcDataClassicIO & operator= (FrTOCAdcDataClassicIO &&TOC)
 
 FrTOCAdcDataClassicIO ()=default
 Default constructor.
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
void QueryAdc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrAdcData being written.
 
const FrTOCAdcDataClassicIO & operator= (const Previous::FrTOCImpl::FrTOCAdcDataClassicIO &Source)
 asignment operator
 
FrTOCAdcDataClassicIO & operator= (FrTOCAdcDataClassicIO &&TOC)
 
const MapADC_type & GetADC () 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 MapADC_type & GetADC () 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_type & GetKeys () const
 Retrieve the keys.
 
const key_container_type & GetKeys () const
 Retrieve the keys.
 
bool operator== (const FrTOCAdcData &RHS) const
 equality operator
 
bool operator== (const FrTOCAdcData &RHS) const
 equality operator
 

Static Public Member Functions

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

Public Attributes

position_type m_positions_start
 

Protected Member Functions

void Load (istream_type &Stream, INT_4U FrameCount)
 Read contents from stream.
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
void cachePositions (istream_type &Stream)
 Cache where the positions of the Adc channels.
 
void seekPositions (istream_type &Stream, channel_id_type Channel)
 Advance to the specified Adc channel.
 
void seekPositions (istream_type &Stream, const std::string &Channel)
 Advance to the specified Adc channel.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
void Load (istream_type &Stream, INT_4U FrameCount)
 Read contents from stream.
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
void cachePositions (istream_type &Stream)
 Cache where the positions of the Adc channels.
 
void seekPositions (istream_type &Stream, channel_id_type Channel)
 Advance to the specified Adc channel.
 
void seekPositions (istream_type &Stream, const std::string &Channel)
 Advance to the specified Adc channel.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 

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 &Channel)
 
MapADC_type::iterator getADC (INT_4U Channel)
 
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 &Channel)
 
MapADC_type::iterator getADC (INT_4U Channel)
 
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 [1/2]

typedef INT_4U FrameCPP::v9::FrTOCAdcData::channel_id_type
inherited

◆ channel_id_type [2/2]

typedef INT_4U FrameCPP::v9::FrTOCAdcData::channel_id_type
inherited

◆ group_id_type [1/2]

typedef INT_4U FrameCPP::v9::FrTOCAdcData::group_id_type
inherited

◆ group_id_type [2/2]

typedef INT_4U FrameCPP::v9::FrTOCAdcData::group_id_type
inherited

◆ key_container_type [1/2]

typedef std::vector< name_type > FrameCPP::v9::FrTOCAdcData::key_container_type
inherited

◆ key_container_type [2/2]

typedef std::vector< name_type > FrameCPP::v9::FrTOCAdcData::key_container_type
inherited

◆ MapADC_type [1/2]

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

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::v9::FrTOCAdcData::MapADC_type
inherited

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 INT_4U FrameCPP::v9::FrTOCAdcData::nadc_type
inherited

◆ nadc_type [2/2]

typedef INT_4U FrameCPP::v9::FrTOCAdcData::nadc_type
inherited

◆ name_type [1/2]

typedef std::string FrameCPP::v9::FrTOCAdcData::name_type
inherited

◆ name_type [2/2]

typedef std::string FrameCPP::v9::FrTOCAdcData::name_type
inherited

◆ position_type [1/2]

typedef INT_8U FrameCPP::v9::FrTOCAdcData::position_type
inherited

◆ position_type [2/2]

typedef INT_8U FrameCPP::v9::FrTOCAdcData::position_type
inherited

◆ positions_cache_type [1/2]

typedef std::vector< position_type > FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::positions_cache_type
private

◆ positions_cache_type [2/2]

typedef std::vector< position_type > FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::positions_cache_type
private

◆ reverse_lookup_type [1/2]

typedef LDASTools::AL::unordered_map< std::string, INT_4U > FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::reverse_lookup_type
private

◆ reverse_lookup_type [2/2]

typedef LDASTools::AL::unordered_map< std::string, INT_4U > FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::reverse_lookup_type
private

Constructor & Destructor Documentation

◆ FrTOCAdcDataClassicIO() [1/2]

FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::FrTOCAdcDataClassicIO ( )
default

Default constructor.

◆ FrTOCAdcDataClassicIO() [2/2]

FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::FrTOCAdcDataClassicIO ( )
default

Default constructor.

Member Function Documentation

◆ Bytes() [1/2]

Common::FrameSpec::size_type FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::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_9::FrTOCImpl::FrTOCAdcDataClassicIO::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.

◆ cachePositions() [1/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::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_9::FrTOCImpl::FrTOCAdcDataClassicIO::cachePositions ( istream_type & Stream)
inlineprotected

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

◆ Description() [1/2]

template<typename SE>
static void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::Description ( Common::Description & Desc)
inlinestatic

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_9::FrTOCImpl::FrTOCAdcDataClassicIO::Description ( Common::Description & Desc)
inlinestatic

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_9::FrTOCImpl::FrTOCAdcDataClassicIO::forEach ( Common::FrTOC::query_info_type Info,
Common::FrTOC::FunctionBase & Action ) const
inlineprotected

Iterate over contents.

Parameters
[in]InfoSpecifies the type of information to be searched.
[in]ActionAction to be taken for each piece of information found.

◆ forEach() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::forEach ( Common::FrTOC::query_info_type Info,
Common::FrTOC::FunctionBase & Action ) const
inlineprotected

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::v9::FrTOCAdcData::GetADC ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrAdcData elements.

◆ GetADC() [2/6]

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

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
inlineinherited

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
inherited

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
inlineinherited

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
inherited

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::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::getADC ( )
inlineprivate

◆ getADC() [2/6]

MapADC_type & FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::getADC ( )
inlineprivate

◆ getADC() [3/6]

MapADC_type::iterator FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::getADC ( const std::string & Channel)
inlineprivate

◆ getADC() [4/6]

MapADC_type::iterator FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::getADC ( const std::string & Channel)
inlineprivate

◆ getADC() [5/6]

MapADC_type::iterator FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::getADC ( INT_4U Channel)
inlineprivate

◆ getADC() [6/6]

MapADC_type::iterator FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::getADC ( INT_4U Channel)
inlineprivate

◆ GetKeys() [1/2]

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

Retrieve the keys.

Returns
Constant container of keys.

◆ GetKeys() [2/2]

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

Retrieve the keys.

Returns
Constant container of keys.

◆ Load() [1/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::Load ( istream_type & Stream,
INT_4U FrameCount )
protected

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ Load() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::Load ( istream_type & Stream,
INT_4U FrameCount )
protected

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ operator=() [1/4]

const FrTOCAdcDataClassicIO & FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::operator= ( const Previous::FrTOCImpl::FrTOCAdcDataClassicIO & Source)
inline

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator=() [2/4]

const FrTOCAdcDataClassicIO & FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::operator= ( const Previous::FrTOCImpl::FrTOCAdcDataClassicIO & Source)
inline

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator=() [3/4]

FrTOCAdcDataClassicIO & FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::operator= ( FrTOCAdcDataClassicIO && TOC)
inline

◆ operator=() [4/4]

FrTOCAdcDataClassicIO & FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::operator= ( FrTOCAdcDataClassicIO && TOC)
inline

◆ operator==() [1/2]

bool FrameCPP::v9::FrTOCAdcData::operator== ( const FrTOCAdcData & RHS) const
inherited

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
inherited

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_9::FrTOCImpl::FrTOCAdcDataClassicIO::QueryAdc ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inline

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_9::FrTOCImpl::FrTOCAdcDataClassicIO::QueryAdc ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inline

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]

reverse_lookup_type::mapped_type FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::reverse_lookup ( const reverse_lookup_type::key_type & Key) const
inlineprivate

◆ reverse_lookup() [2/2]

reverse_lookup_type::mapped_type FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::reverse_lookup ( const reverse_lookup_type::key_type & Key) const
inlineprivate

◆ seekPositions() [1/4]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::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() [2/4]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::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_9::FrTOCImpl::FrTOCAdcDataClassicIO::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

◆ seekPositions() [4/4]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::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_9::FrTOCImpl::FrTOCAdcDataClassicIO::write ( Common::OStream & Stream) const
inlineprotected

Write the structure to the stream.

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

◆ write() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::write ( Common::OStream & Stream) const
inlineprotected

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::v9::FrTOCAdcData::m_info
protectedinherited

◆ m_keys

key_container_type FrameCPP::v9::FrTOCAdcData::m_keys
protectedinherited

◆ m_positions_start

position_type FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::m_positions_start

◆ positions_cache

positions_cache_type FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::positions_cache
private

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

◆ positions_cache_offset

position_type FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::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_9::FrTOCImpl::FrTOCAdcDataClassicIO::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: