Indexed elements of the FrAdcData structure.
More...
#include <FrTOCAdcData.hh>
|
MapADC_type & | getADC () |
|
MapADC_type::iterator | getADC (const std::string &Name) |
|
MapADC_type::iterator | getADC (INT_4U index) |
|
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 &Name) |
|
MapADC_type::iterator | getADC (INT_4U index) |
|
reverse_lookup_type::mapped_type | reverse_lookup (const reverse_lookup_type::key_type &key) const |
|
Indexed elements of the FrAdcData structure.
◆ adc_info_type [1/2]
◆ adc_info_type [2/2]
◆ channel_id_type [1/2]
◆ channel_id_type [2/2]
◆ group_id_type [1/2]
◆ group_id_type [2/2]
◆ key_container_type [1/2]
◆ key_container_type [2/2]
◆ MapADC_type [1/2]
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]
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]
◆ nadc_type [2/2]
◆ name_type [1/2]
◆ name_type [2/2]
◆ position_type [1/2]
◆ position_type [2/2]
◆ positions_cache_type [1/2]
◆ positions_cache_type [2/2]
◆ reverse_lookup_type [1/2]
◆ reverse_lookup_type [2/2]
◆ FrTOCAdcData() [1/4]
FrameCPP::Version_8::FrTOCAdcData::FrTOCAdcData |
( |
| ) |
|
◆ FrTOCAdcData() [2/4]
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. |
◆ FrTOCAdcData() [3/4]
FrameCPP::Version_8::FrTOCAdcData::FrTOCAdcData |
( |
| ) |
|
◆ FrTOCAdcData() [4/4]
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() [1/2]
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.
◆ Bytes() [2/2]
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() [1/2]
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 |
◆ cachePositions() [2/2]
void FrameCPP::Version_8::FrTOCAdcData::cachePositions |
( |
istream_type & | Stream | ) |
|
|
protected |
Cache where the positions of the Adc channels.
- Parameters
-
[in,out] | Stream | The Stream being read |
◆ Description() [1/2]
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.
◆ Description() [2/2]
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() [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] | 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.
◆ 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] | Info | Specifies the type of information to be searched. |
[in] | Action | Action to be taken for each piece of information found. |
◆ getADC() [1/6]
◆ getADC() [2/6]
MapADC_type & FrameCPP::Version_8::FrTOCAdcData::getADC |
( |
| ) |
|
|
private |
◆ GetADC() [1/6]
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::iterator FrameCPP::Version_8::FrTOCAdcData::getADC |
( |
const std::string & | Name | ) |
|
|
inlineprivate |
◆ getADC() [4/6]
MapADC_type::iterator FrameCPP::Version_8::FrTOCAdcData::getADC |
( |
const std::string & | Name | ) |
|
|
private |
◆ 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] | Name | The 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] | Name | The name of the channel. |
- Returns
- Constant iterator to the indexed FrAdcData element.
◆ getADC() [5/6]
FrTOCAdcData::MapADC_type::iterator FrameCPP::Version_8::FrTOCAdcData::getADC |
( |
INT_4U | index | ) |
|
|
inlineprivate |
◆ getADC() [6/6]
MapADC_type::iterator FrameCPP::Version_8::FrTOCAdcData::getADC |
( |
INT_4U | index | ) |
|
|
private |
◆ 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] | index | The 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] | index | The numeric offset of the channel. |
- Returns
- Constant iterator to the indexed FrAdcData element.
◆ GetKeys() [1/2]
Retrieve the keys.
- Returns
- Constant container of keys.
◆ GetKeys() [2/2]
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] | Source | The source to be copied. |
◆ operator=() [2/2]
const FrTOCAdcData & FrameCPP::Version_8::FrTOCAdcData::operator= |
( |
const Previous::FrTOCAdcData & | Source | ) |
|
asignment operator
- Parameters
-
[in] | Source | The source to be copied. |
◆ operator==() [1/2]
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.
◆ operator==() [2/2]
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() [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] | 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. |
◆ 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] | 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. |
◆ reverse_lookup() [1/2]
FrTOCAdcData::reverse_lookup_type::mapped_type FrameCPP::Version_8::FrTOCAdcData::reverse_lookup |
( |
const reverse_lookup_type::key_type & | key | ) |
const |
|
inlineprivate |
◆ reverse_lookup() [2/2]
reverse_lookup_type::mapped_type FrameCPP::Version_8::FrTOCAdcData::reverse_lookup |
( |
const reverse_lookup_type::key_type & | key | ) |
const |
|
private |
◆ seekPositions() [1/4]
Advance to the specified Adc channel.
- Parameters
-
[in,out] | Stream | The Stream being read |
[in] | Channel | The requested channel |
◆ seekPositions() [2/4]
Advance to the specified Adc channel.
- Parameters
-
[in,out] | Stream | The Stream being read |
[in] | Channel | The 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] | Stream | The Stream being read |
[in] | Channel | The 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] | Stream | The Stream being read |
[in] | Channel | The requested channel |
◆ write() [1/2]
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. |
◆ write() [2/2]
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 |
◆ positions_cache
A cache of the positions of the FrAdcData structures within the stream.
◆ positions_cache_offset
position_type FrameCPP::Version_8::FrTOCAdcData::positions_cache_offset |
|
private |
The number of bytes from the end of the stream where the array containing the FrAdcData offsets.
◆ reverse_lookup_
Provide means where a channel index can be mapped to a channel name
The documentation for this class was generated from the following files: