Indexed elements of the FrAdcData structure.
More...
#include <FrTOCAdcData.hh>
Indexed elements of the FrAdcData structure.
◆ adc_info_type
◆ channel_id_type
◆ group_id_type
◆ key_container_type
◆ 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
◆ name_type
◆ position_type
◆ FrTOCAdcData() [1/2]
FrameCPP::Version_8::FrTOCAdcData::FrTOCAdcData |
( |
| ) |
|
◆ FrTOCAdcData() [2/2]
FrameCPP::Version_8::FrTOCAdcData::FrTOCAdcData |
( |
Common::IStream & |
Stream, |
|
|
INT_4U |
FrameCount |
|
) |
| |
|
protected |
Stream constructor.
- Parameters
-
[in] | Stream | The input stream from where the object is being read. |
[in] | FrameCount | The frame offset. |
◆ Bytes()
Number of bytes needed to write this structure.
- Parameters
-
[in] | Stream | The stream from which to the object is being read or written. |
- Returns
- The number of bytes need to read or write this object.
◆ cachePositions()
void FrameCPP::Version_8::FrTOCAdcData::cachePositions |
( |
istream_type & |
Stream | ) |
|
|
inlineprotected |
Cache where the positions of the Adc channels.
- Parameters
-
[in,out] | Stream | The Stream being read |
◆ Description()
The description of structure.
- Parameters
-
[out] | Desc | Storage for the description of the structure. |
- Returns
- A Description object which describes this structure as specified by the frame specification.
◆ forEach()
Iterate over contents.
- Parameters
-
[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.
◆ GetADC() [1/3]
Return all channels.
- Returns
- Constant container to the indexed FrAdcData elements.
◆ GetADC() [2/3]
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] | Name | The name of the channel. |
- Returns
- Constant iterator to the indexed FrAdcData element.
◆ GetADC() [3/3]
FrTOCAdcData::MapADC_type::const_iterator FrameCPP::Version_8::FrTOCAdcData::GetADC |
( |
INT_4U |
index | ) |
const |
Return the indexed data for an indexed channel.
- Parameters
-
[in] | index | The numeric offset of the channel. |
- Returns
- Constant iterator to the indexed FrAdcData element.
◆ GetKeys()
Retrieve the keys.
- Returns
- Constant container of keys.
◆ operator=()
const FrTOCAdcData & FrameCPP::Version_8::FrTOCAdcData::operator= |
( |
const Previous::FrTOCAdcData & |
Source | ) |
|
asignment operator
- Parameters
-
[in] | Source | The source to be copied. |
◆ operator==()
bool FrameCPP::Version_8::FrTOCAdcData::operator== |
( |
const FrTOCAdcData & |
RHS | ) |
const |
equality operator
- Parameters
-
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ QueryAdc()
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] | 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. |
◆ seekPositions() [1/2]
Advance to the specified Adc channel.
- Parameters
-
[in,out] | Stream | The Stream being read |
[in] | Channel | The requested channel |
◆ seekPositions() [2/2]
void FrameCPP::Version_8::FrTOCAdcData::seekPositions |
( |
istream_type & |
Stream, |
|
|
const std::string & |
Channel |
|
) |
| |
|
inlineprotected |
Advance to the specified Adc channel.
- Parameters
-
[in,out] | Stream | The Stream being read |
[in] | Channel | The requested channel |
◆ write()
void FrameCPP::Version_8::FrTOCAdcData::write |
( |
Common::OStream & |
Stream | ) |
const |
|
protected |
Write the structure to the stream.
- Parameters
-
[in] | Stream | The output stream where the object is to be written. |
◆ m_info
◆ m_keys
◆ m_positions_start
position_type FrameCPP::Version_8::FrTOCAdcData::m_positions_start |
The documentation for this class was generated from the following files: