Indexed elements of the FrSummary structure.
More...
#include <FrTOCSummary.hh>
Indexed elements of the FrSummary structure.
◆ frame_count_type
◆ info_type
◆ key_container_type
◆ Map_type
◆ MapSummary_type
◆ n_type
◆ name_type
◆ nsummary_type
◆ position_type
◆ summary_info_type
◆ FrTOCSummary() [1/2]
FrameCPP::Version_8::FrTOCSummary::FrTOCSummary |
( |
| ) |
|
|
inline |
◆ FrTOCSummary() [2/2]
FrameCPP::Version_8::FrTOCSummary::FrTOCSummary |
( |
Common::IStream & |
Stream, |
|
|
INT_4U |
FrameCount |
|
) |
| |
|
inlineprotected |
Stream constructor.
- Parameters
-
[in] | Stream | The input stream from where the object is being read. |
[in] | FrameCount | The frame offset. |
◆ Bytes()
◆ 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.
◆ getInfo() [1/3]
◆ getInfo() [2/3]
FrTOCPosition::Map_type::const_iterator FrameCPP::Version_4::FrTOCPosition::getInfo |
( |
const std::string & |
Name | ) |
const |
|
inlineprotectedinherited |
◆ getInfo() [3/3]
FrTOCPosition::Map_type::const_iterator FrameCPP::Version_4::FrTOCPosition::getInfo |
( |
INT_4U |
Index | ) |
const |
|
inlineprotectedinherited |
◆ GetPositionKeys()
◆ GetSummary() [1/3]
Return all summary elements.
- Returns
- Constant container to the indexed FrSummary elements.
◆ GetSummary() [2/3]
FrTOCSummary::MapSummary_type::const_iterator FrameCPP::Version_8::FrTOCSummary::GetSummary |
( |
const std::string & |
Name | ) |
const |
|
inline |
Return the indexed data for a named summary elemnet.
- Parameters
-
[in] | Name | The name of the summary elment. |
- Returns
- Constant iterator to the indexed FrSummary element.
◆ GetSummary() [3/3]
FrTOCSummary::MapSummary_type::const_iterator FrameCPP::Version_8::FrTOCSummary::GetSummary |
( |
INT_4U |
index | ) |
const |
|
inline |
Return the indexed data for an index summary element.
- Parameters
-
[in] | index | The numeric offset of the summary element. |
- Returns
- Constant iterator to the indexed FrSummary element.
◆ operator=()
const FrTOCSummary & FrameCPP::Version_8::FrTOCSummary::operator= |
( |
const Previous::FrTOCSummary & |
Source | ) |
|
asignment operator
- Parameters
-
[in] | Source | The source to be copied. |
◆ operator==() [1/2]
bool FrameCPP::Version_4::FrTOCPosition::operator== |
( |
const FrTOCPosition & |
RHS | ) |
const |
|
protectedinherited |
◆ operator==() [2/2]
bool FrameCPP::Version_8::FrTOCSummary::operator== |
( |
const FrTOCSummary & |
RHS | ) |
const |
equality operator
- Parameters
-
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ QuerySum()
void FrameCPP::Version_8::FrTOCSummary::QuerySum |
( |
const Common::TOCInfo & |
Info, |
|
|
INT_4U |
FrameOffset, |
|
|
INT_8U |
Position |
|
) |
| |
Gather TOC info for FrSummary 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()
void FrameCPP::Version_8::FrTOCSummary::write |
( |
Common::OStream & |
Stream | ) |
const |
|
inlineprotected |
Write the structure to the stream.
- Parameters
-
[in] | Stream | The output stream where the object is to be written. |
◆ m_info
Map_type FrameCPP::Version_4::FrTOCPosition::m_info |
|
protectedinherited |
◆ m_keys
The documentation for this class was generated from the following files: