Indexed elements of the FrSummary structure. More...

#include <FrTOCSummary.hh>

Inheritance diagram for FrameCPP::Version_8::FrTOCSummary:

Public Member Functions
	FrTOCSummary ()
	Default constructor.

const MapSummary_type &	GetSummary () const
	Return all summary elements. More...

MapSummary_type::const_iterator	GetSummary (const std::string &Name) const
	Return the indexed data for a named summary elemnet. More...

MapSummary_type::const_iterator	GetSummary (INT_4U index) const
	Return the indexed data for an index summary element. More...

void	QuerySum (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
	Gather TOC info for FrSummary being written. More...

const FrTOCSummary &	operator= (const Previous::FrTOCSummary &Source)
	asignment operator More...

bool	operator== (const FrTOCSummary &RHS) const
	equality operator More...

	FrTOCSummary ()
	Default constructor.

const MapSummary_type &	GetSummary () const
	Return all summary elements. More...

MapSummary_type::const_iterator	GetSummary (const std::string &Name) const
	Return the indexed data for a named summary elemnet. More...

MapSummary_type::const_iterator	GetSummary (INT_4U index) const
	Return the indexed data for an index summary element. More...

void	QuerySum (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
	Gather TOC info for FrSummary being written. More...

const FrTOCSummary &	operator= (const Previous::FrTOCSummary &Source)
	asignment operator More...

bool	operator== (const FrTOCSummary &RHS) const
	equality operator More...

	FrTOCSummary ()
	Default constructor.

const MapSummary_type &	GetSummary () const
	Return all summary elements. More...

MapSummary_type::const_iterator	GetSummary (const std::string &Name) const
	Return the indexed data for a named summary elemnet. More...

MapSummary_type::const_iterator	GetSummary (INT_4U index) const
	Return the indexed data for an index summary element. More...

void	QuerySum (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
	Gather TOC info for FrSummary being written. More...

const FrTOCSummary &	operator= (const Previous::FrTOCSummary &Source)
	asignment operator More...

bool	operator== (const FrTOCSummary &RHS) const
	equality operator More...

Static Public Member Functions
template<typename SE >
static void	Description (Common::Description &Desc)
	The description of structure. More...

template<typename SE >
static void	Description (Common::Description &Desc)
	The description of structure. More...

template<typename SE >
static void	Description (Common::Description &Desc)
	The description of structure. More...

Protected Member Functions
	FrTOCSummary (Common::IStream &Stream, INT_4U FrameCount)
	Stream constructor. More...

void	write (Common::OStream &Stream) const
	Write the structure to the stream. More...

	FrTOCSummary (Common::IStream &Stream, INT_4U FrameCount)
	Stream constructor. More...

void	write (Common::OStream &Stream) const
	Write the structure to the stream. More...

	FrTOCSummary (Common::IStream &Stream, INT_4U FrameCount)
	Stream constructor. More...

void	write (Common::OStream &Stream) const
	Write the structure to the stream. More...

Detailed Description

Indexed elements of the FrSummary structure.

Constructor & Destructor Documentation

◆ FrTOCSummary() [1/3]

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/3]

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.

◆ FrTOCSummary() [3/3]

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.

Member Function Documentation

◆ Description() [1/3]

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/3]

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.

◆ Description() [3/3]

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/9]

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/9]

const MapSummary_type& FrameCPP::Version_8::FrTOCSummary::GetSummary ( ) const

Return all summary elements.

Returns: Constant container to the indexed FrSummary elements.

◆ GetSummary() [3/9]

const MapSummary_type& FrameCPP::Version_8::FrTOCSummary::GetSummary ( ) const

Return all summary elements.

Returns: Constant container to the indexed FrSummary elements.

◆ GetSummary() [4/9]

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/9]

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() [6/9]

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() [7/9]

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() [8/9]

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.

◆ GetSummary() [9/9]

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/3]

const FrTOCSummary& FrameCPP::Version_8::FrTOCSummary::operator= ( const Previous::FrTOCSummary & Source )

asignment operator

Parameters

[in] Source The source to be copied.

◆ operator=() [2/3]

const FrTOCSummary & FrameCPP::Version_8::FrTOCSummary::operator= ( const Previous::FrTOCSummary & Source )

asignment operator

Parameters

[in] Source The source to be copied.

◆ operator=() [3/3]

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_8::FrTOCSummary::operator== ( const FrTOCSummary & RHS ) const

equality operator

Parameters

[in] RHS The FrTOCAdcData object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [2/3]

bool FrameCPP::Version_8::FrTOCSummary::operator== ( const FrTOCSummary & RHS ) const

equality operator

Parameters

[in] RHS The FrTOCAdcData object to be compared.

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

[in] RHS The FrTOCAdcData object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ QuerySum() [1/3]

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/3]

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() [3/3]

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/3]

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/3]

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.

◆ write() [3/3]

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:

/build/ldas-tools-framecpp-2.7.0/debian/tmp/usr/include/framecpp/Version8/FrTOCSummary.hh
/build/ldas-tools-framecpp-2.7.0/src/Version8/FrTOCSummary.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FrTOCSummary() [1/3]

◆ FrTOCSummary() [2/3]

◆ FrTOCSummary() [3/3]

Member Function Documentation

◆ Description() [1/3]

◆ Description() [2/3]

◆ Description() [3/3]

◆ GetSummary() [1/9]

◆ GetSummary() [2/9]

◆ GetSummary() [3/9]

◆ GetSummary() [4/9]

◆ GetSummary() [5/9]

◆ GetSummary() [6/9]

◆ GetSummary() [7/9]

◆ GetSummary() [8/9]

◆ GetSummary() [9/9]

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]

◆ QuerySum() [1/3]

◆ QuerySum() [2/3]

◆ QuerySum() [3/3]

◆ write() [1/3]

◆ write() [2/3]

◆ write() [3/3]