Indexed elements of the FrSummary structure.
More...
#include <FrTOCSummary.hh>
Indexed elements of the FrSummary structure.
◆ frame_count_type [1/2]
◆ frame_count_type [2/2]
◆ info_type [1/2]
◆ info_type [2/2]
◆ key_container_type [1/2]
◆ key_container_type [2/2]
◆ Map_type [1/2]
◆ Map_type [2/2]
◆ MapSummary_type [1/2]
◆ MapSummary_type [2/2]
◆ n_type [1/2]
◆ n_type [2/2]
◆ name_type [1/2]
◆ name_type [2/2]
◆ nsummary_type [1/2]
◆ nsummary_type [2/2]
◆ position_type [1/2]
◆ position_type [2/2]
◆ summary_info_type [1/2]
◆ summary_info_type [2/2]
◆ FrTOCSummary() [1/4]
FrameCPP::Version_8::FrTOCSummary::FrTOCSummary |
( |
| ) |
|
|
inline |
◆ FrTOCSummary() [2/4]
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. |
◆ FrTOCSummary() [3/4]
FrameCPP::Version_8::FrTOCSummary::FrTOCSummary |
( |
| ) |
|
◆ FrTOCSummary() [4/4]
FrameCPP::Version_8::FrTOCSummary::FrTOCSummary |
( |
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]
◆ Bytes() [2/2]
◆ 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.
◆ getInfo() [1/6]
◆ getInfo() [2/6]
const Map_type & FrameCPP::Version_4::FrTOCPosition::getInfo |
( |
| ) |
const |
|
protectedinherited |
◆ getInfo() [3/6]
FrTOCPosition::Map_type::const_iterator FrameCPP::Version_4::FrTOCPosition::getInfo |
( |
const std::string & | Name | ) |
const |
|
inlineprotectedinherited |
◆ getInfo() [4/6]
Map_type::const_iterator FrameCPP::Version_4::FrTOCPosition::getInfo |
( |
const std::string & | Name | ) |
const |
|
protectedinherited |
◆ getInfo() [5/6]
FrTOCPosition::Map_type::const_iterator FrameCPP::Version_4::FrTOCPosition::getInfo |
( |
INT_4U | Index | ) |
const |
|
inlineprotectedinherited |
◆ getInfo() [6/6]
Map_type::const_iterator FrameCPP::Version_4::FrTOCPosition::getInfo |
( |
INT_4U | Index | ) |
const |
|
protectedinherited |
◆ GetPositionKeys() [1/2]
◆ GetPositionKeys() [2/2]
◆ GetSummary() [1/6]
Return all summary elements.
- Returns
- Constant container to the indexed FrSummary elements.
◆ GetSummary() [2/6]
const MapSummary_type & FrameCPP::Version_8::FrTOCSummary::GetSummary |
( |
| ) |
const |
Return all summary elements.
- Returns
- Constant container to the indexed FrSummary elements.
◆ GetSummary() [3/6]
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() [4/6]
MapSummary_type::const_iterator FrameCPP::Version_8::FrTOCSummary::GetSummary |
( |
const std::string & | Name | ) |
const |
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() [5/6]
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.
◆ GetSummary() [6/6]
MapSummary_type::const_iterator FrameCPP::Version_8::FrTOCSummary::GetSummary |
( |
INT_4U | index | ) |
const |
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=() [1/2]
const FrTOCSummary & FrameCPP::Version_8::FrTOCSummary::operator= |
( |
const Previous::FrTOCSummary & | Source | ) |
|
asignment operator
- Parameters
-
[in] | Source | The source to be copied. |
◆ operator=() [2/2]
const FrTOCSummary & FrameCPP::Version_8::FrTOCSummary::operator= |
( |
const Previous::FrTOCSummary & | Source | ) |
|
asignment operator
- Parameters
-
[in] | Source | The source to be copied. |
◆ operator==() [1/3]
bool FrameCPP::Version_4::FrTOCPosition::operator== |
( |
const FrTOCPosition & | RHS | ) |
const |
|
protectedinherited |
◆ operator==() [2/3]
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.
◆ operator==() [3/3]
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() [1/2]
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. |
◆ QuerySum() [2/2]
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() [1/2]
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. |
◆ write() [2/2]
void FrameCPP::Version_8::FrTOCSummary::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
Map_type FrameCPP::Version_4::FrTOCPosition::m_info |
|
protectedinherited |
◆ m_keys
The documentation for this class was generated from the following files: