ldas-tools-framecpp
2.7.0
|
Indexed elements of the FrAdcData structure. More...
#include <FrTOCAdcData.hh>
Public Types | |
typedef std::map< name_type, adc_info_type > | MapADC_type |
Container of indexed FrAdcData elements. More... | |
typedef std::map< name_type, adc_info_type > | MapADC_type |
Container of indexed FrAdcData elements. More... | |
Public Member Functions | |
FrTOCAdcData () | |
Default constructor. | |
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. | |
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... | |
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... | |
Indexed elements of the FrAdcData structure.
typedef std::map< name_type, adc_info_type > FrameCPP::Version_8::FrTOCAdcData::MapADC_type |
typedef std::map< name_type, adc_info_type > FrameCPP::Version_8::FrTOCAdcData::MapADC_type |
|
protected |
Stream constructor.
[in] | Stream | The input stream from where the object is being read. |
[in] | FrameCount | The frame offset. |
|
protected |
Stream constructor.
[in] | Stream | The input stream from where the object is being read. |
[in] | FrameCount | The frame offset. |
|
inline |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCAdcData::Bytes | ( | const Common::StreamBase & | Stream | ) | const |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
|
inlineprotected |
Cache where the positions of the Adc channels.
[in,out] | Stream | The Stream being read |
|
protected |
Cache where the positions of the Adc channels.
[in,out] | Stream | The Stream being read |
|
static |
The description of structure.
[out] | Desc | Storage for the description of the structure. |
|
static |
The description of structure.
[out] | Desc | Storage for the description of the structure. |
|
protected |
Iterate over contents.
[in] | Info | Specifies the type of information to be searched. |
[in] | Action | Action 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.
|
protected |
Iterate over contents.
[in] | Info | Specifies the type of information to be searched. |
[in] | Action | Action to be taken for each piece of information found. |
|
inline |
Return all channels.
const MapADC_type& FrameCPP::Version_8::FrTOCAdcData::GetADC | ( | ) | const |
Return all channels.
MapADC_type::const_iterator FrameCPP::Version_8::FrTOCAdcData::GetADC | ( | const std::string & | Name | ) | const |
Return the indexed data for a named channel.
[in] | Name | The name of the channel. |
FrTOCAdcData::MapADC_type::const_iterator FrameCPP::Version_8::FrTOCAdcData::GetADC | ( | const std::string & | Name | ) | const |
Return the indexed data for a named channel.
[in] | Name | The name of the channel. |
FrTOCAdcData::MapADC_type::const_iterator FrameCPP::Version_8::FrTOCAdcData::GetADC | ( | INT_4U | index | ) | const |
Return the indexed data for an indexed channel.
[in] | index | The numeric offset of the channel. |
MapADC_type::const_iterator FrameCPP::Version_8::FrTOCAdcData::GetADC | ( | INT_4U | index | ) | const |
Return the indexed data for an indexed channel.
[in] | index | The numeric offset of the channel. |
const key_container_type& FrameCPP::Version_8::FrTOCAdcData::GetKeys | ( | ) | const |
Retrieve the keys.
|
inline |
Retrieve the keys.
const FrTOCAdcData& FrameCPP::Version_8::FrTOCAdcData::operator= | ( | const Previous::FrTOCAdcData & | Source | ) |
asignment operator
[in] | Source | The source to be copied. |
const FrTOCAdcData & FrameCPP::Version_8::FrTOCAdcData::operator= | ( | const Previous::FrTOCAdcData & | Source | ) |
asignment operator
[in] | Source | The source to be copied. |
bool FrameCPP::Version_8::FrTOCAdcData::operator== | ( | const FrTOCAdcData & | RHS | ) | const |
equality operator
[in] | RHS | The FrTOCAdcData object to be compared. |
bool FrameCPP::Version_8::FrTOCAdcData::operator== | ( | const FrTOCAdcData & | RHS | ) | const |
equality operator
[in] | RHS | The FrTOCAdcData object to be compared. |
void FrameCPP::Version_8::FrTOCAdcData::QueryAdc | ( | const Common::TOCInfo & | Info, |
INT_4U | FrameOffset, | ||
INT_8U | Position | ||
) |
Gather TOC info for FrAdcData being written.
[in] | Info | Information |
[in] | FrameOffset | The frame offset of the frame being written. The frame offsets start at 0 (zero). |
[in] | Position | The byte offset from the start of the file where the structure is written. |
void FrameCPP::Version_8::FrTOCAdcData::QueryAdc | ( | const Common::TOCInfo & | Info, |
INT_4U | FrameOffset, | ||
INT_8U | Position | ||
) |
Gather TOC info for FrAdcData being written.
[in] | Info | Information |
[in] | FrameOffset | The frame offset of the frame being written. The frame offsets start at 0 (zero). |
[in] | Position | The byte offset from the start of the file where the structure is written. |
|
protected |
Advance to the specified Adc channel.
[in,out] | Stream | The Stream being read |
[in] | Channel | The requested channel |
|
inlineprotected |
Advance to the specified Adc channel.
[in,out] | Stream | The Stream being read |
[in] | Channel | The requested channel |
|
protected |
Advance to the specified Adc channel.
[in,out] | Stream | The Stream being read |
[in] | Channel | The requested channel |
|
inlineprotected |
Advance to the specified Adc channel.
[in,out] | Stream | The Stream being read |
[in] | Channel | The requested channel |
|
protected |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
|
protected |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |