Indexed elements of the FrProcData structure.
More...
#include <FrTOCProcData.hh>
Indexed elements of the FrProcData structure.
FrameCPP::Version_8::FrTOCProcData::FrTOCProcData |
( |
| ) |
|
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. |
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.
TOC optimization.
This method optimizes the TOC reading by only reading the structure offsets. Once read, it is moved into the structure.
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.
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.
Retrieve the keys.
- Returns
- Constant container of keys.
Return all channels.
- Returns
- Constant container to the indexed FrProcData elements.
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.
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.
const FrTOCProcData & FrameCPP::Version_8::FrTOCProcData::operator= |
( |
const Previous::FrTOCProcData & |
Source | ) |
|
asignment operator
- Parameters
-
[in] | Source | The source to be copied. |
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.
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. |
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. |
The documentation for this class was generated from the following files: