Indexed elements of the FrProcData structure.
More...
#include <FrTOCProcData.hh>
Indexed elements of the FrProcData structure.
◆ key_container_type [1/2]
◆ key_container_type [2/2]
◆ MapProc_type [1/2]
◆ MapProc_type [2/2]
◆ name_type [1/2]
◆ name_type [2/2]
◆ nproc_type [1/2]
◆ nproc_type [2/2]
◆ position_type [1/2]
◆ position_type [2/2]
◆ proc_info_type [1/2]
◆ proc_info_type [2/2]
◆ FrTOCProcData() [1/4]
FrameCPP::Version_8::FrTOCProcData::FrTOCProcData |
( |
| ) |
|
◆ FrTOCProcData() [2/4]
FrameCPP::Version_8::FrTOCProcData::FrTOCProcData |
( |
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. |
◆ FrTOCProcData() [3/4]
FrameCPP::Version_8::FrTOCProcData::FrTOCProcData |
( |
| ) |
|
◆ FrTOCProcData() [4/4]
FrameCPP::Version_8::FrTOCProcData::FrTOCProcData |
( |
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.
◆ 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::FrTOCProcData::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::FrTOCProcData::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. |
◆ GetKeys() [1/2]
Retrieve the keys.
- Returns
- Constant container of keys.
◆ GetKeys() [2/2]
Retrieve the keys.
- Returns
- Constant container of keys.
◆ GetProc() [1/6]
Return all channels.
- Returns
- Constant container to the indexed FrProcData elements.
◆ GetProc() [2/6]
const MapProc_type & FrameCPP::Version_8::FrTOCProcData::GetProc |
( |
| ) |
const |
Return all channels.
- Returns
- Constant container to the indexed FrProcData elements.
◆ GetProc() [3/6]
FrTOCProcData::MapProc_type::const_iterator FrameCPP::Version_8::FrTOCProcData::GetProc |
( |
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 FrProcData element.
◆ GetProc() [4/6]
MapProc_type::const_iterator FrameCPP::Version_8::FrTOCProcData::GetProc |
( |
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 FrProcData element.
◆ GetProc() [5/6]
FrTOCProcData::MapProc_type::const_iterator FrameCPP::Version_8::FrTOCProcData::GetProc |
( |
INT_4U |
index | ) |
const |
Return the indexed data for a named channel.
- Parameters
-
[in] | index | The numeric offset of the channel. |
- Returns
- Constant iterator to the indexed FrProcData element.
◆ GetProc() [6/6]
MapProc_type::const_iterator FrameCPP::Version_8::FrTOCProcData::GetProc |
( |
INT_4U |
index | ) |
const |
Return the indexed data for a named channel.
- Parameters
-
[in] | index | The numeric offset of the channel. |
- Returns
- Constant iterator to the indexed FrProcData element.
◆ operator=() [1/2]
const FrTOCProcData & FrameCPP::Version_8::FrTOCProcData::operator= |
( |
const Previous::FrTOCProcData & |
Source | ) |
|
asignment operator
- Parameters
-
[in] | Source | The source to be copied. |
◆ operator=() [2/2]
const FrTOCProcData & FrameCPP::Version_8::FrTOCProcData::operator= |
( |
const Previous::FrTOCProcData & |
Source | ) |
|
asignment operator
- Parameters
-
[in] | Source | The source to be copied. |
◆ operator==() [1/2]
bool FrameCPP::Version_8::FrTOCProcData::operator== |
( |
const FrTOCProcData & |
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::FrTOCProcData::operator== |
( |
const FrTOCProcData & |
RHS | ) |
const |
equality operator
- Parameters
-
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ QueryProc() [1/2]
void FrameCPP::Version_8::FrTOCProcData::QueryProc |
( |
const Common::TOCInfo & |
Info, |
|
|
INT_4U |
FrameOffset, |
|
|
INT_8U |
Position |
|
) |
| |
Gather TOC info for FrProcData 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. |
◆ QueryProc() [2/2]
void FrameCPP::Version_8::FrTOCProcData::QueryProc |
( |
const Common::TOCInfo & |
Info, |
|
|
INT_4U |
FrameOffset, |
|
|
INT_8U |
Position |
|
) |
| |
Gather TOC info for FrProcData 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. |
◆ write() [1/2]
void FrameCPP::Version_8::FrTOCProcData::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::FrTOCProcData::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
The documentation for this class was generated from the following files: