DtStatisticsXmlBlock< NumericType > Class Template Reference

The DtStatisticsXmlBlock provides simple statistics tracking Note: to work with the block factory, the creation methods must be specialized by the numeric type of the data, and a new XML Tag must be registered for each specialization. More...

Inheritance diagram for DtStatisticsXmlBlock< NumericType >:

Collaboration diagram for DtStatisticsXmlBlock< NumericType >:

List of all members.

Public Types
typedef NumericType	ValueType
typedef DtBoost::shared_ptr < DtStatisticsXmlBlock < NumericType > >	BlockSP
typedef DtBoost::weak_ptr < DtStatisticsXmlBlock < NumericType > >	BlockWP
Public Member Functions
	DtStatisticsXmlBlock (MAKRti::DtEnvValueSP existingNode, MAKRti::DtEnvValueSP root)
	DtStatisticsXmlBlock (const MAKRti::DtString &name, MAKRti::DtEnvValueSP root)
virtual	~DtStatisticsXmlBlock ()
virtual void	reset ()
virtual void	set (unsigned int count, ValueType total, ValueType minimum, ValueType maximum, ValueType average)
virtual void	addStatistic (const NumericType &stat)
unsigned int	count () const
ValueType	total () const
ValueType	minimum () const
ValueType	maximum () const
double	average () const
template<>
	DtStatisticsXmlBlock (const DtString &name, DtEnvValueSP root)
template<>
	DtStatisticsXmlBlock (const DtString &name, DtEnvValueSP root)
template<>
	DtStatisticsXmlBlock (const MAKRti::DtString &name, MAKRti::DtEnvValueSP root)
template<>
	DtStatisticsXmlBlock (const MAKRti::DtString &name, MAKRti::DtEnvValueSP root)
Static Public Member Functions
static DtSpyXmlBlockSP	create (DtNodeAndParentPair xmlNodeAndParent)
Protected Member Functions
	DtStatisticsXmlBlock (const MAKRti::DtString &name, const MAKRti::DtString &typeTag, MAKRti::DtEnvValueSP root)
Protected Attributes
bool	myInReset
DtSpyXmlBlockElement< unsigned int, true >	myCount
DtSpyXmlBlockElement < NumericType, true >	myTotal
DtSpyXmlBlockElement < NumericType, true >	myMin
DtSpyXmlBlockElement < NumericType, true >	myMax
DtSpyXmlBlockElement< double, true >	myAvg

---

Detailed Description

template<typename NumericType>
class DtStatisticsXmlBlock< NumericType >

The DtStatisticsXmlBlock provides simple statistics tracking Note: to work with the block factory, the creation methods must be specialized by the numeric type of the data, and a new XML Tag must be registered for each specialization.

---

Member Typedef Documentation

template<typename NumericType>

typedef DtBoost::shared_ptr< DtStatisticsXmlBlock< NumericType > > DtStatisticsXmlBlock< NumericType >::BlockSP

template<typename NumericType>

typedef DtBoost::weak_ptr< DtStatisticsXmlBlock< NumericType > > DtStatisticsXmlBlock< NumericType >::BlockWP

template<typename NumericType>

typedef NumericType DtStatisticsXmlBlock< NumericType >::ValueType

---

Constructor & Destructor Documentation

template<typename NumericType >

DtStatisticsXmlBlock< NumericType >::DtStatisticsXmlBlock	(	MAKRti::DtEnvValueSP	existingNode,
		MAKRti::DtEnvValueSP	root
	)

template<typename NumericType >

DtStatisticsXmlBlock< NumericType >::DtStatisticsXmlBlock	(	const MAKRti::DtString &	name,
		MAKRti::DtEnvValueSP	root
	)

template<typename NumericType >

DtStatisticsXmlBlock< NumericType >::~DtStatisticsXmlBlock

(

)

[virtual]

template<typename NumericType >

DtStatisticsXmlBlock< NumericType >::DtStatisticsXmlBlock	(	const MAKRti::DtString &	name,
		const MAKRti::DtString &	typeTag,
		MAKRti::DtEnvValueSP	root
	)		[protected]

template<>

DtStatisticsXmlBlock< int >::DtStatisticsXmlBlock	(	const DtString &	name,
		DtEnvValueSP	root
	)

template<>

DtStatisticsXmlBlock< float >::DtStatisticsXmlBlock	(	const DtString &	name,
		DtEnvValueSP	root
	)

template<>

DtStatisticsXmlBlock< int >::DtStatisticsXmlBlock	(	const MAKRti::DtString &	name,
		MAKRti::DtEnvValueSP	root
	)

template<>

DtStatisticsXmlBlock< float >::DtStatisticsXmlBlock	(	const MAKRti::DtString &	name,
		MAKRti::DtEnvValueSP	root
	)

---

Member Function Documentation

template<typename NumericType>

void DtStatisticsXmlBlock< NumericType >::addStatistic

(

const NumericType &

stat

)

[virtual]

Referenced by DtLrcApiStatsXmlBlock::fedAmbCalled(), DtLrcStateDatabaseXmlBlock::fedAmbCalled(), DtLrcStateDatabaseXmlBlock::messageRead(), DtLrcMsgStatsXmlBlock::messageRead(), DtLrcStateDatabaseXmlBlock::messageSent(), DtLrcMsgStatsXmlBlock::messageSent(), DtMsgStatsXmlBlock::recordReadMsg(), DtMsgStatsXmlBlock::recordSentMsg(), DtLrcApiStatsXmlBlock::rtiAmbCalled(), and DtLrcStateDatabaseXmlBlock::rtiAmbCalled().

template<typename NumericType >

double DtStatisticsXmlBlock< NumericType >::average

(

)

const

template<typename NumericType >

unsigned int DtStatisticsXmlBlock< NumericType >::count

(

)

const

template<typename NumericType >

DtSpyXmlBlockSP DtStatisticsXmlBlock< NumericType >::create

(

DtNodeAndParentPair

xmlNodeAndParent

)

[static]

Reimplemented in DtApiStatsXmlBlock.

template<typename NumericType >

DtStatisticsXmlBlock< NumericType >::ValueType DtStatisticsXmlBlock< NumericType >::maximum

(

)

const

template<typename NumericType >

DtStatisticsXmlBlock< NumericType >::ValueType DtStatisticsXmlBlock< NumericType >::minimum

(

)

const

template<typename NumericType >

void DtStatisticsXmlBlock< NumericType >::reset

(

)

[virtual]

Referenced by DtLrcApiStatsXmlBlock::reset(), DtMsgStatsXmlBlock::reset(), DtLrcStateDatabaseXmlBlock::reset(), and DtLrcMsgStatsXmlBlock::reset().

template<typename NumericType >

void DtStatisticsXmlBlock< NumericType >::set	(	unsigned int	count,
		ValueType	total,
		ValueType	minimum,
		ValueType	maximum,
		ValueType	average
	)		[virtual]

template<typename NumericType >

DtStatisticsXmlBlock< NumericType >::ValueType DtStatisticsXmlBlock< NumericType >::total

(

)

const

---

Member Data Documentation

template<typename NumericType>

DtSpyXmlBlockElement< double, true > DtStatisticsXmlBlock< NumericType >::myAvg [protected]

template<typename NumericType>

DtSpyXmlBlockElement< unsigned int, true > DtStatisticsXmlBlock< NumericType >::myCount [protected]

template<typename NumericType>

bool DtStatisticsXmlBlock< NumericType >::myInReset [protected]

template<typename NumericType>

DtSpyXmlBlockElement< NumericType, true > DtStatisticsXmlBlock< NumericType >::myMax [protected]

template<typename NumericType>

DtSpyXmlBlockElement< NumericType, true > DtStatisticsXmlBlock< NumericType >::myMin [protected]

template<typename NumericType>

DtSpyXmlBlockElement< NumericType, true > DtStatisticsXmlBlock< NumericType >::myTotal [protected]

---

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

• statisticsXmlBlock.h
• statisticsXmlBlock.inl