Indexed elements of the FrSummary structure.
More...
#include <FrTOCSummary.hh>
|
| FrTOCSummary () |
| Default constructor.
|
|
const MapSummary_type & | GetSummary () const |
| Return all summary elements.
|
|
MapSummary_type::const_iterator | GetSummary (const std::string &Name) const |
| Return the indexed data for a named summary elemnet.
|
|
MapSummary_type::const_iterator | GetSummary (INT_4U index) const |
| Return the indexed data for an index summary element.
|
|
void | QuerySum (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position) |
| Gather TOC info for FrSummary being written.
|
|
const FrTOCSummary & | operator= (const Previous::FrTOCSummary &Source) |
| asignment operator
|
|
bool | operator== (const FrTOCSummary &RHS) const |
| equality operator
|
|
| FrTOCSummary () |
| Default constructor.
|
|
const MapSummary_type & | GetSummary () const |
| Return all summary elements.
|
|
MapSummary_type::const_iterator | GetSummary (const std::string &Name) const |
| Return the indexed data for a named summary elemnet.
|
|
MapSummary_type::const_iterator | GetSummary (INT_4U index) const |
| Return the indexed data for an index summary element.
|
|
void | QuerySum (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position) |
| Gather TOC info for FrSummary being written.
|
|
const FrTOCSummary & | operator= (const Previous::FrTOCSummary &Source) |
| asignment operator
|
|
bool | operator== (const FrTOCSummary &RHS) const |
| equality operator
|
|
|
template<typename SE > |
static void | Description (Common::Description &Desc) |
| The description of structure.
|
|
template<typename SE > |
static void | Description (Common::Description &Desc) |
| The description of structure.
|
|
|
| FrTOCSummary (Common::IStream &Stream, INT_4U FrameCount) |
| Stream constructor.
|
|
void | write (Common::OStream &Stream) const |
| Write the structure to the stream.
|
|
| FrTOCSummary (Common::IStream &Stream, INT_4U FrameCount) |
| Stream constructor.
|
|
void | write (Common::OStream &Stream) const |
| Write the structure to the stream.
|
|
Indexed elements of the FrSummary structure.
◆ FrTOCSummary() [1/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. |
◆ FrTOCSummary() [2/2]
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. |
◆ Description() [1/2]
template<typename SE >
void FrameCPP::Version_8::FrTOCSummary::Description |
( |
Common::Description & |
Desc | ) |
|
|
static |
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]
template<typename SE >
static void FrameCPP::Version_8::FrTOCSummary::Description |
( |
Common::Description & |
Desc | ) |
|
|
static |
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.
◆ GetSummary() [1/6]
const FrTOCSummary::MapSummary_type & FrameCPP::Version_8::FrTOCSummary::GetSummary |
( |
| ) |
const |
|
inline |
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/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.
◆ 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() [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. |
The documentation for this class was generated from the following files:
- /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-2.7.0/include/framecpp/Version8/FrTOCSummary.hh
- Version8/FrTOCSummary.hh
- Version8/FrTOCSummary.cc