ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | 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 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

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

Protected Member Functions

 FrTOCAdcData (Common::IStream &Stream, INT_4U FrameCount)
 Stream constructor.
 
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.
 
 FrTOCAdcData (Common::IStream &Stream, INT_4U FrameCount)
 Stream constructor.
 
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.
 

Detailed Description

Indexed elements of the FrAdcData structure.

Member Typedef Documentation

◆ 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.

Constructor & Destructor Documentation

◆ FrTOCAdcData() [1/2]

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() [2/2]

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]

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() [4/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() [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.

◆ 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.

◆ seekPositions() [1/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() [2/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() [3/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

◆ seekPositions() [4/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

◆ 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.

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