Indexed elements of the FrSimData structure. More...

#include <FrTOCStatData.hh>

Inheritance diagram for FrameCPP::Version_8::FrTOCStatData:

Classes
struct	stat_instance_type

struct	stat_type

Public Types
typedef STRING	name_type

typedef INT_4U	nstat_type

typedef STRING	detector_type

typedef INT_4U	nstat_instance_type

typedef INT_4U	tstart_type

typedef INT_4U	tend_type

typedef INT_4U	version_type

typedef INT_8U	positionStat_type

typedef std::vector< stat_instance_type >	stat_instance_container_type

typedef std::map< name_type, stat_type >	stat_container_type

typedef STRING	name_type

typedef INT_4U	nstat_type

typedef STRING	detector_type

typedef INT_4U	nstat_instance_type

typedef INT_4U	tstart_type

typedef INT_4U	tend_type

typedef INT_4U	version_type

typedef INT_8U	positionStat_type

typedef std::vector< stat_instance_type >	stat_instance_container_type

typedef std::map< name_type, stat_type >	stat_container_type

typedef STRING	name_type

typedef INT_4U	nstat_type

typedef STRING	detector_type

typedef INT_4U	nstat_instance_type

typedef INT_4U	tstart_type

typedef INT_4U	tend_type

typedef INT_4U	version_type

typedef INT_8U	positionStat_type

typedef std::vector< stat_instance_type >	stat_instance_container_type

typedef std::map< name_type, stat_type >	stat_container_type

Public Member Functions
	FrTOCStatData ()
	Default constructor. More...

Common::FrameSpec::size_type	Bytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure. More...

const stat_container_type &	GetStat () const
	Return all channels. More...

INT_4U	GetNTotalStat () const
	Return number of FrStatData structures. More...

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

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

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

	FrTOCStatData ()
	Default constructor. More...

Common::FrameSpec::size_type	Bytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure. More...

const stat_container_type &	GetStat () const
	Return all channels. More...

INT_4U	GetNTotalStat () const
	Return number of FrStatData structures. More...

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

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

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

	FrTOCStatData ()
	Default constructor. More...

Common::FrameSpec::size_type	Bytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure. More...

const stat_container_type &	GetStat () const
	Return all channels. More...

INT_4U	GetNTotalStat () const
	Return number of FrStatData structures. More...

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

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

void	QueryStatData (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
	Gather TOC info for FrStatData being written. 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
	FrTOCStatData (Common::IStream &Stream)
	Stream constructor. More...

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

	FrTOCStatData (Common::IStream &Stream)
	Stream constructor. More...

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

	FrTOCStatData (Common::IStream &Stream)
	Stream constructor. More...

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

Protected Attributes
stat_container_type	m_info

Detailed Description

Indexed elements of the FrSimData structure.

Member Typedef Documentation

◆ detector_type [1/3]

typedef STRING FrameCPP::Version_8::FrTOCStatData::detector_type

◆ detector_type [2/3]

typedef STRING FrameCPP::Version_8::FrTOCStatData::detector_type

◆ detector_type [3/3]

typedef STRING FrameCPP::Version_8::FrTOCStatData::detector_type

◆ name_type [1/3]

typedef STRING FrameCPP::Version_8::FrTOCStatData::name_type

◆ name_type [2/3]

typedef STRING FrameCPP::Version_8::FrTOCStatData::name_type

◆ name_type [3/3]

typedef STRING FrameCPP::Version_8::FrTOCStatData::name_type

◆ nstat_instance_type [1/3]

typedef INT_4U FrameCPP::Version_8::FrTOCStatData::nstat_instance_type

◆ nstat_instance_type [2/3]

typedef INT_4U FrameCPP::Version_8::FrTOCStatData::nstat_instance_type

◆ nstat_instance_type [3/3]

typedef INT_4U FrameCPP::Version_8::FrTOCStatData::nstat_instance_type

◆ nstat_type [1/3]

typedef INT_4U FrameCPP::Version_8::FrTOCStatData::nstat_type

◆ nstat_type [2/3]

typedef INT_4U FrameCPP::Version_8::FrTOCStatData::nstat_type

◆ nstat_type [3/3]

typedef INT_4U FrameCPP::Version_8::FrTOCStatData::nstat_type

◆ positionStat_type [1/3]

typedef INT_8U FrameCPP::Version_8::FrTOCStatData::positionStat_type

◆ positionStat_type [2/3]

typedef INT_8U FrameCPP::Version_8::FrTOCStatData::positionStat_type

◆ positionStat_type [3/3]

typedef INT_8U FrameCPP::Version_8::FrTOCStatData::positionStat_type

◆ stat_container_type [1/3]

typedef std::map< name_type, stat_type > FrameCPP::Version_8::FrTOCStatData::stat_container_type

◆ stat_container_type [2/3]

typedef std::map< name_type, stat_type > FrameCPP::Version_8::FrTOCStatData::stat_container_type

◆ stat_container_type [3/3]

typedef std::map< name_type, stat_type > FrameCPP::Version_8::FrTOCStatData::stat_container_type

◆ stat_instance_container_type [1/3]

typedef std::vector< stat_instance_type > FrameCPP::Version_8::FrTOCStatData::stat_instance_container_type

◆ stat_instance_container_type [2/3]

typedef std::vector< stat_instance_type > FrameCPP::Version_8::FrTOCStatData::stat_instance_container_type

◆ stat_instance_container_type [3/3]

typedef std::vector< stat_instance_type > FrameCPP::Version_8::FrTOCStatData::stat_instance_container_type

◆ tend_type [1/3]

typedef INT_4U FrameCPP::Version_8::FrTOCStatData::tend_type

◆ tend_type [2/3]

typedef INT_4U FrameCPP::Version_8::FrTOCStatData::tend_type

◆ tend_type [3/3]

typedef INT_4U FrameCPP::Version_8::FrTOCStatData::tend_type

◆ tstart_type [1/3]

typedef INT_4U FrameCPP::Version_8::FrTOCStatData::tstart_type

◆ tstart_type [2/3]

typedef INT_4U FrameCPP::Version_8::FrTOCStatData::tstart_type

◆ tstart_type [3/3]

typedef INT_4U FrameCPP::Version_8::FrTOCStatData::tstart_type

◆ version_type [1/3]

typedef INT_4U FrameCPP::Version_8::FrTOCStatData::version_type

◆ version_type [2/3]

typedef INT_4U FrameCPP::Version_8::FrTOCStatData::version_type

◆ version_type [3/3]

typedef INT_4U FrameCPP::Version_8::FrTOCStatData::version_type

Constructor & Destructor Documentation

◆ FrTOCStatData() [1/6]

FrameCPP::Version_8::FrTOCStatData::FrTOCStatData ( )

Default constructor.

◆ FrTOCStatData() [2/6]

FrameCPP::Version_8::FrTOCStatData::FrTOCStatData ( Common::IStream & Stream )

protected

Stream constructor.

Parameters

[in] Stream The input stream from where the object is being read.

◆ FrTOCStatData() [3/6]

FrameCPP::Version_8::FrTOCStatData::FrTOCStatData ( )

Default constructor.

◆ FrTOCStatData() [4/6]

FrameCPP::Version_8::FrTOCStatData::FrTOCStatData ( Common::IStream & Stream )

protected

Stream constructor.

Parameters

[in] Stream The input stream from where the object is being read.

◆ FrTOCStatData() [5/6]

FrameCPP::Version_8::FrTOCStatData::FrTOCStatData ( )

Default constructor.

◆ FrTOCStatData() [6/6]

FrameCPP::Version_8::FrTOCStatData::FrTOCStatData ( Common::IStream & Stream )

protected

Stream constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Member Function Documentation

◆ Bytes() [1/3]

Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCStatData::Bytes ( const Common::StreamBase & Stream ) const

inline

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.

◆ Bytes() [2/3]

Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCStatData::Bytes ( const Common::StreamBase & Stream ) const

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.

◆ Bytes() [3/3]

Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCStatData::Bytes ( const Common::StreamBase & Stream ) const

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.

◆ Description() [1/3]

template<typename SE >

static void FrameCPP::Version_8::FrTOCStatData::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 >

void FrameCPP::Version_8::FrTOCStatData::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::FrTOCStatData::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.

◆ GetNTotalStat() [1/3]

INT_4U FrameCPP::Version_8::FrTOCStatData::GetNTotalStat ( ) const

Return number of FrStatData structures.

Returns: The number of FrStatData structures.

◆ GetNTotalStat() [2/3]

INT_4U FrameCPP::Version_8::FrTOCStatData::GetNTotalStat ( ) const

Return number of FrStatData structures.

Returns: The number of FrStatData structures.

◆ GetNTotalStat() [3/3]

INT_4U FrameCPP::Version_8::FrTOCStatData::GetNTotalStat ( ) const

inline

Return number of FrStatData structures.

Returns: The number of FrStatData structures.

◆ GetStat() [1/3]

const FrTOCStatData::stat_container_type & FrameCPP::Version_8::FrTOCStatData::GetStat ( ) const

inline

Return all channels.

Returns: Constant container to the indexed FrStatData elements.

◆ GetStat() [2/3]

const stat_container_type& FrameCPP::Version_8::FrTOCStatData::GetStat ( ) const

Return all channels.

Returns: Constant container to the indexed FrStatData elements.

◆ GetStat() [3/3]

const stat_container_type& FrameCPP::Version_8::FrTOCStatData::GetStat ( ) const

Return all channels.

Returns: Constant container to the indexed FrStatData elements.

◆ operator=() [1/3]

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

asignment operator

Parameters

[in] Source The source to be copied.

◆ operator=() [2/3]

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

asignment operator

Parameters

[in] Source The source to be copied.

◆ operator=() [3/3]

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

asignment operator

Parameters

[in] Source The source to be copied.

◆ operator==() [1/3]

bool FrameCPP::Version_8::FrTOCStatData::operator== ( const FrTOCStatData & 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::FrTOCStatData::operator== ( const FrTOCStatData & 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::FrTOCStatData::operator== ( const FrTOCStatData & 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.

◆ QueryStatData() [1/3]

void FrameCPP::Version_8::FrTOCStatData::QueryStatData	(	const Common::TOCInfo &	Info,
		INT_4U	FrameOffset,
		INT_8U	Position
	)

Gather TOC info for FrStatData 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.

◆ QueryStatData() [2/3]

void FrameCPP::Version_8::FrTOCStatData::QueryStatData	(	const Common::TOCInfo &	Info,
		INT_4U	FrameOffset,
		INT_8U	Position
	)

Gather TOC info for FrStatData 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.

◆ QueryStatData() [3/3]

void FrameCPP::Version_8::FrTOCStatData::QueryStatData	(	const Common::TOCInfo &	Info,
		INT_4U	FrameOffset,
		INT_8U	Position
	)

Gather TOC info for FrStatData 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::FrTOCStatData::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() [2/3]

void FrameCPP::Version_8::FrTOCStatData::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::FrTOCStatData::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.

Member Data Documentation

◆ m_info

stat_container_type FrameCPP::Version_8::FrTOCStatData::m_info

protected

The documentation for this class was generated from the following files:

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ detector_type [1/3]

◆ detector_type [2/3]

◆ detector_type [3/3]

◆ name_type [1/3]

◆ name_type [2/3]

◆ name_type [3/3]

◆ nstat_instance_type [1/3]

◆ nstat_instance_type [2/3]

◆ nstat_instance_type [3/3]

◆ nstat_type [1/3]

◆ nstat_type [2/3]

◆ nstat_type [3/3]

◆ positionStat_type [1/3]

◆ positionStat_type [2/3]

◆ positionStat_type [3/3]

◆ stat_container_type [1/3]

◆ stat_container_type [2/3]

◆ stat_container_type [3/3]

◆ stat_instance_container_type [1/3]

◆ stat_instance_container_type [2/3]

◆ stat_instance_container_type [3/3]

◆ tend_type [1/3]

◆ tend_type [2/3]

◆ tend_type [3/3]

◆ tstart_type [1/3]

◆ tstart_type [2/3]

◆ tstart_type [3/3]

◆ version_type [1/3]

◆ version_type [2/3]

◆ version_type [3/3]

Constructor & Destructor Documentation

◆ FrTOCStatData() [1/6]

◆ FrTOCStatData() [2/6]

◆ FrTOCStatData() [3/6]

◆ FrTOCStatData() [4/6]

◆ FrTOCStatData() [5/6]

◆ FrTOCStatData() [6/6]

Member Function Documentation

◆ Bytes() [1/3]

◆ Bytes() [2/3]

◆ Bytes() [3/3]

◆ Description() [1/3]

◆ Description() [2/3]

◆ Description() [3/3]

◆ GetNTotalStat() [1/3]

◆ GetNTotalStat() [2/3]

◆ GetNTotalStat() [3/3]

◆ GetStat() [1/3]

◆ GetStat() [2/3]

◆ GetStat() [3/3]

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]

◆ QueryStatData() [1/3]

◆ QueryStatData() [2/3]

◆ QueryStatData() [3/3]

◆ write() [1/3]

◆ write() [2/3]

◆ write() [3/3]

Member Data Documentation

◆ m_info