ldas-tools-framecpp  2.6.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected 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:
FrameCPP::Version_8::FrTOC

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_typekey_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_typeGetADC () 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_typeGetKeys () 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 FrTOCAdcDataoperator= (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...
 

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

Protected Attributes

key_container_type m_keys
 
MapADC_type m_info
 

Detailed Description

Indexed elements of the FrAdcData structure.

Member Typedef Documentation

typedef Previous::FrTOCAdcData::adc_info_type FrameCPP::Version_8::FrTOCAdcData::adc_info_type
typedef Previous::FrTOCAdcData::channel_id_type FrameCPP::Version_8::FrTOCAdcData::channel_id_type
typedef Previous::FrTOCAdcData::group_id_type FrameCPP::Version_8::FrTOCAdcData::group_id_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.

typedef Previous::FrTOCAdcData::nadc_type FrameCPP::Version_8::FrTOCAdcData::nadc_type
typedef Previous::FrTOCAdcData::name_type FrameCPP::Version_8::FrTOCAdcData::name_type
typedef Previous::FrTOCAdcData::position_type FrameCPP::Version_8::FrTOCAdcData::position_type

Constructor & Destructor Documentation

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

Default constructor.

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

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

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

Return all channels.

Returns
Constant container to the indexed FrAdcData elements.
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.
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.
const FrTOCAdcData::key_container_type & FrameCPP::Version_8::FrTOCAdcData::GetKeys ( ) const
inline

Retrieve the keys.

Returns
Constant container of keys.
const FrTOCAdcData & FrameCPP::Version_8::FrTOCAdcData::operator= ( const Previous::FrTOCAdcData &  Source)

asignment operator

Parameters
[in]SourceThe source to be copied.
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.
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.
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
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
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

MapADC_type FrameCPP::Version_8::FrTOCAdcData::m_info
protected
key_container_type FrameCPP::Version_8::FrTOCAdcData::m_keys
protected
position_type FrameCPP::Version_8::FrTOCAdcData::m_positions_start

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