ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_8::FrTOCStatData Class Reference

Indexed elements of the FrSimData structure. More...

#include <FrTOCStatData.hh>

Inheritance diagram for FrameCPP::Version_8::FrTOCStatData:
Inheritance graph
[legend]

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_typestat_instance_container_type
 
typedef std::map< name_type, stat_typestat_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_typestat_instance_container_type
 
typedef std::map< name_type, stat_typestat_container_type
 

Public Member Functions

 FrTOCStatData ()
 Default constructor.
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
const stat_container_typeGetStat () const
 Return all channels.
 
INT_4U GetNTotalStat () const
 Return number of FrStatData structures.
 
const FrTOCStatDataoperator= (const Previous::FrTOCStatData &Source)
 asignment operator
 
bool operator== (const FrTOCStatData &RHS) const
 equality operator
 
void QueryStatData (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrStatData being written.
 
 FrTOCStatData ()
 Default constructor.
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
const stat_container_typeGetStat () const
 Return all channels.
 
INT_4U GetNTotalStat () const
 Return number of FrStatData structures.
 
const FrTOCStatDataoperator= (const Previous::FrTOCStatData &Source)
 asignment operator
 
bool operator== (const FrTOCStatData &RHS) const
 equality operator
 
void QueryStatData (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrStatData being written.
 

Static Public Member Functions

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.
 

Protected Member Functions

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

Protected Attributes

stat_container_type m_info
 

Detailed Description

Indexed elements of the FrSimData structure.

Member Typedef Documentation

◆ detector_type [1/2]

◆ detector_type [2/2]

◆ name_type [1/2]

◆ name_type [2/2]

◆ nstat_instance_type [1/2]

◆ nstat_instance_type [2/2]

◆ nstat_type [1/2]

◆ nstat_type [2/2]

◆ positionStat_type [1/2]

◆ positionStat_type [2/2]

◆ stat_container_type [1/2]

◆ stat_container_type [2/2]

◆ stat_instance_container_type [1/2]

◆ stat_instance_container_type [2/2]

◆ tend_type [1/2]

◆ tend_type [2/2]

◆ tstart_type [1/2]

◆ tstart_type [2/2]

◆ version_type [1/2]

◆ version_type [2/2]

Constructor & Destructor Documentation

◆ FrTOCStatData() [1/4]

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

Default constructor.

◆ FrTOCStatData() [2/4]

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

Stream constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

◆ FrTOCStatData() [3/4]

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

Default constructor.

◆ FrTOCStatData() [4/4]

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

Stream constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

Member Function Documentation

◆ Bytes() [1/2]

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]StreamThe 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/2]

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

Number of bytes needed to write this structure.

Parameters
[in]StreamThe 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/2]

template<typename SE >
void FrameCPP::Version_8::FrTOCStatData::Description ( Common::Description Desc)
static

The description of structure.

Parameters
[out]DescStorage 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::FrTOCStatData::Description ( Common::Description Desc)
static

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.

◆ GetNTotalStat() [1/2]

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

Return number of FrStatData structures.

Returns
The number of FrStatData structures.

◆ GetNTotalStat() [2/2]

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

Return number of FrStatData structures.

Returns
The number of FrStatData structures.

◆ GetStat() [1/2]

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

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

Return all channels.

Returns
Constant container to the indexed FrStatData elements.

◆ operator=() [1/2]

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

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator=() [2/2]

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

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator==() [1/2]

bool FrameCPP::Version_8::FrTOCStatData::operator== ( const FrTOCStatData RHS) const

equality operator

Parameters
[in]RHSThe FrTOCAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [2/2]

bool FrameCPP::Version_8::FrTOCStatData::operator== ( const FrTOCStatData RHS) const

equality operator

Parameters
[in]RHSThe FrTOCAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ QueryStatData() [1/2]

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]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ QueryStatData() [2/2]

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]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ write() [1/2]

void FrameCPP::Version_8::FrTOCStatData::write ( Common::OStream Stream) const
protected

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ write() [2/2]

void FrameCPP::Version_8::FrTOCStatData::write ( Common::OStream Stream) const
protected

Write the structure to the stream.

Parameters
[in]StreamThe 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: