FREE::Statistics Class Reference
[Statistics]

Class containing statistical information about the whole registration. More...

#include <freStatistics.h>

Inheritance diagram for FREE::Statistics:

[legend]

Collaboration diagram for FREE::Statistics:

[legend]

List of all members.

Public Types
typedef std::map < std::string, std::string >	StatisticsTagMapTyp
Public Member Functions
StatisticData &	GetData ()
StatisticDictionary &	GetDictionary ()
StatisticsTagMapTyp &	GetTags ()
const StatisticsTagMapTyp &	GetTags () const
	Statistics ()
virtual	~Statistics ()
virtual void	Reset ()
Public Attributes
std::string	m_sDescription
Protected Member Functions
virtual void	SubElementLoadProcessing (const std::string &rsXMLSubTag, const std::string &rsXMLSubElement, const std::string &rsXMLSubData)
virtual std::string	SaveData (const unsigned int &iDepth, bool &bHasSubElements) const
virtual void	SaveAttributes (AttributesSaveListType &rAttributes) const
Protected Attributes
StatisticData::Pointer	m_smpData
StatisticDictionary::Pointer	m_smpDictionary
StatisticsTagMapTyp	m_Tags

---

Detailed Description

Class containing statistical information about the whole registration.

Statistics is used to store statistical information about the whole registration process. It can be plugged to the Registrator if statistical computation is wished, otherwise no statistics will be computed. The actual section is always the last added to Statistic.

Definition at line 46 of file freStatistics.h.

---

Member Typedef Documentation

typedef std::map<std::string,std::string> FREE::Statistics::StatisticsTagMapTyp

Definition at line 54 of file freStatistics.h.

---

Constructor & Destructor Documentation

FREE::Statistics::Statistics

(

)

Implementation of FREE::Statistics /////////////////////////////////

Definition at line 36 of file freStatistics.cxx.

References Reset().

Here is the call graph for this function:

FREE::Statistics::~Statistics

(

)

[virtual]

Definition at line 42 of file freStatistics.cxx.

References Reset().

Here is the call graph for this function:

---

Member Function Documentation

StatisticData& FREE::Statistics::GetData

(

)

[inline]

Definition at line 49 of file freStatistics.h.

References m_smpData.

Referenced by FREE::ComponentControllerBase< TControlledComponent >::AddStatisticEntry(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EvaluationFinished(), FREE::SetupOptimizationMetric::GetDecomposedValue(), FREE::SetupOptimizationMetric::GetDerivative(), FREE::SetupOptimizationMetric::GetValue(), and FREE::SetupOptimizationMetric::GetValueAndDerivative().

StatisticDictionary& FREE::Statistics::GetDictionary

(

)

[inline]

Definition at line 50 of file freStatistics.h.

Referenced by FREE::ComponentControllerBase< TControlledComponent >::AddStatisticEntry(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextLevel(), and FREE::ComponentControllerBase< TControlledComponent >::SetStatisticEntry().

StatisticsTagMapTyp& FREE::Statistics::GetTags

(

)

[inline]

Definition at line 56 of file freStatistics.h.

References m_Tags.

const StatisticsTagMapTyp& FREE::Statistics::GetTags

(

)

const [inline]

Definition at line 57 of file freStatistics.h.

References m_Tags.

void FREE::Statistics::Reset

(

)

[virtual]

Resets data and dictionary.

Resets the value to an empty string and undefined type.

Reimplemented from FREE::XMLStreamObject.

Definition at line 50 of file freStatistics.cxx.

References m_sDescription, m_smpData, m_smpDictionary, m_Tags, and FREE::StatisticData::New().

Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize(), Statistics(), and ~Statistics().

Here is the call graph for this function:

void FREE::Statistics::SubElementLoadProcessing	(	const std::string &	rsXMLSubTag,
		const std::string &	rsXMLSubElement,
		const std::string &	rsXMLSubData
	)			[protected, virtual]

Reimplemented from FREE::XMLStreamObject.

Definition at line 60 of file freStatistics.cxx.

References m_sDescription, m_smpData, and m_smpDictionary.

std::string FREE::Statistics::SaveData	(	const unsigned int &	iDepth,
		bool &	bHasSubElements
	)			const [protected, virtual]

Reimplemented from FREE::XMLStreamObject.

Definition at line 69 of file freStatistics.cxx.

References FREE::XMLStreamObject::AddSubElement(), m_sDescription, m_smpData, m_smpDictionary, and m_Tags.

Here is the call graph for this function:

void FREE::Statistics::SaveAttributes

(

AttributesSaveListType &

rAttributes

)

const [protected, virtual]

Definition at line 88 of file freStatistics.cxx.

---

Member Data Documentation

std::string FREE::Statistics::m_sDescription

Definition at line 50 of file freStatistics.h.

Referenced by Reset(), SaveData(), and SubElementLoadProcessing().

StatisticData::Pointer FREE::Statistics::m_smpData [protected]

Definition at line 66 of file freStatistics.h.

Referenced by GetData(), Reset(), SaveData(), and SubElementLoadProcessing().

StatisticDictionary::Pointer FREE::Statistics::m_smpDictionary [protected]

Definition at line 67 of file freStatistics.h.

Referenced by Reset(), SaveData(), and SubElementLoadProcessing().

StatisticsTagMapTyp FREE::Statistics::m_Tags [protected]

Definition at line 69 of file freStatistics.h.

Referenced by GetTags(), Reset(), and SaveData().

---

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

• freStatistics.h
• freStatistics.cxx

---