FREE::StatisticEntryDefinition Class Reference
[Statistics]

Class contains the dictionary information of one entry. More...

#include <freStatisticEntryDefinition.h>

Inheritance diagram for FREE::StatisticEntryDefinition:

[legend]

Collaboration diagram for FREE::StatisticEntryDefinition:

[legend]

List of all members.

Public Types
typedef StatisticEntryDefinition	Self
typedef itk::LightObject	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef unsigned long	IDType
Public Member Functions
	itkTypeMacro (StatisticEntryDefinition, XMLStreamObject)
	itkNewMacro (StatisticEntryDefinition)
virtual void	Reset ()
void	SetName (const std::string &sName)
const std::string &	GetName () const
void	SetIDPath (const std::string &sIDPath)
const std::string &	GetIDPath () const
void	SetDescription (const std::string &sDescription)
const std::string &	GetDescription () const
void	SetControllerID (const std::string &sID)
const std::string &	GetControllerID () const
void	SetRefID (const IDType &id)
const IDType &	GetRefID () const
virtual StatisticEntryDefinition &	operator= (const StatisticEntryDefinition &rEntry)
Protected Member Functions
	StatisticEntryDefinition ()
virtual	~StatisticEntryDefinition ()
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
Protected Attributes
std::string	m_sName
std::string	m_sIDPath
std::string	m_sControllerID
std::string	m_sDescription
IDType	m_RefID

---

Detailed Description

Class contains the dictionary information of one entry.

StatisticEntryDefinition is used to store general information about a statistic entry logged in the statistic.

Definition at line 44 of file freStatisticEntryDefinition.h.

---

Member Typedef Documentation

typedef StatisticEntryDefinition FREE::StatisticEntryDefinition::Self

Definition at line 47 of file freStatisticEntryDefinition.h.

typedef itk::LightObject FREE::StatisticEntryDefinition::Superclass

Definition at line 48 of file freStatisticEntryDefinition.h.

typedef itk::SmartPointer<Self> FREE::StatisticEntryDefinition::Pointer

Definition at line 49 of file freStatisticEntryDefinition.h.

typedef itk::SmartPointer<const Self> FREE::StatisticEntryDefinition::ConstPointer

Definition at line 50 of file freStatisticEntryDefinition.h.

typedef unsigned long FREE::StatisticEntryDefinition::IDType

Definition at line 55 of file freStatisticEntryDefinition.h.

---

Constructor & Destructor Documentation

FREE::StatisticEntryDefinition::StatisticEntryDefinition

(

)

[protected]

Definition at line 50 of file freStatisticEntryDefinition.cxx.

References Reset().

Here is the call graph for this function:

FREE::StatisticEntryDefinition::~StatisticEntryDefinition

(

)

[protected, virtual]

Definition at line 56 of file freStatisticEntryDefinition.cxx.

---

Member Function Documentation

FREE::StatisticEntryDefinition::itkTypeMacro	(	StatisticEntryDefinition	,
		XMLStreamObject
	)

FREE::StatisticEntryDefinition::itkNewMacro

(

StatisticEntryDefinition

)

void FREE::StatisticEntryDefinition::Reset

(

)

[virtual]

Resets the value to an empty string and undefined type.

Reimplemented from FREE::XMLStreamObject.

Definition at line 61 of file freStatisticEntryDefinition.cxx.

References m_RefID, m_sControllerID, m_sDescription, m_sIDPath, m_sName, and FREE::XMLStreamObject::Reset().

Referenced by operator=(), and StatisticEntryDefinition().

Here is the call graph for this function:

void FREE::StatisticEntryDefinition::SetName

(

const std::string &

sName

)

[inline]

Definition at line 60 of file freStatisticEntryDefinition.h.

References m_sName.

Referenced by operator=().

const std::string& FREE::StatisticEntryDefinition::GetName

(

)

const [inline]

Definition at line 63 of file freStatisticEntryDefinition.h.

References m_sName.

Referenced by operator=().

void FREE::StatisticEntryDefinition::SetIDPath

(

const std::string &

sIDPath

)

[inline]

Definition at line 66 of file freStatisticEntryDefinition.h.

References m_sIDPath.

Referenced by operator=().

const std::string& FREE::StatisticEntryDefinition::GetIDPath

(

)

const [inline]

Definition at line 69 of file freStatisticEntryDefinition.h.

References m_sIDPath.

Referenced by operator=().

void FREE::StatisticEntryDefinition::SetDescription

(

const std::string &

sDescription

)

[inline]

Definition at line 72 of file freStatisticEntryDefinition.h.

References m_sDescription.

Referenced by operator=().

const std::string& FREE::StatisticEntryDefinition::GetDescription

(

)

const [inline]

Definition at line 75 of file freStatisticEntryDefinition.h.

References m_sDescription.

Referenced by operator=().

void FREE::StatisticEntryDefinition::SetControllerID

(

const std::string &

sID

)

[inline]

Definition at line 78 of file freStatisticEntryDefinition.h.

References m_sControllerID.

Referenced by operator=().

const std::string& FREE::StatisticEntryDefinition::GetControllerID

(

)

const [inline]

Definition at line 81 of file freStatisticEntryDefinition.h.

References m_sControllerID.

Referenced by operator=().

void FREE::StatisticEntryDefinition::SetRefID

(

const IDType &

id

)

[inline]

Definition at line 84 of file freStatisticEntryDefinition.h.

References m_RefID.

Referenced by operator=(), and FREE::SetupOptimizationProcessorController::SetStatisticEntrySubComponents().

const IDType& FREE::StatisticEntryDefinition::GetRefID

(

)

const [inline]

Definition at line 87 of file freStatisticEntryDefinition.h.

References m_RefID.

Referenced by FREE::ComponentControllerBase< TControlledComponent >::AddStatisticEntry(), FREE::StatisticDictionary::GetEntryDefinitionIDByName(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextLevel(), operator=(), FREE::EvolutionaryStrategySOOptimizerController::SetStatisticEntryMainComponent(), FREE::EvolutionaryStrategyOptimizerController::SetStatisticEntryMainComponent(), and FREE::SetupOptimizationProcessorController::SetStatisticEntrySubComponents().

StatisticEntryDefinition & FREE::StatisticEntryDefinition::operator=

(

const StatisticEntryDefinition &

rEntry

)

[virtual]

Assignment operator.

Implementation of FREE::StatisticEntryDefinition ///////////////////

Definition at line 34 of file freStatisticEntryDefinition.cxx.

References GetControllerID(), GetDescription(), GetIDPath(), GetName(), GetRefID(), Reset(), SetControllerID(), SetDescription(), SetIDPath(), SetName(), and SetRefID().

Here is the call graph for this function:

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

Reimplemented from FREE::XMLStreamObject.

Definition at line 73 of file freStatisticEntryDefinition.cxx.

References m_RefID, m_sControllerID, m_sDescription, m_sIDPath, m_sName, and FREE::Convert::ToInt().

Here is the call graph for this function:

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

Reimplemented from FREE::XMLStreamObject.

Definition at line 84 of file freStatisticEntryDefinition.cxx.

References FREE::XMLStreamObject::AddSubElement(), m_RefID, m_sControllerID, m_sDescription, m_sIDPath, m_sName, and FREE::Convert::ToStr().

Here is the call graph for this function:

---

Member Data Documentation

std::string FREE::StatisticEntryDefinition::m_sName [protected]

Definition at line 94 of file freStatisticEntryDefinition.h.

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

std::string FREE::StatisticEntryDefinition::m_sIDPath [protected]

Definition at line 95 of file freStatisticEntryDefinition.h.

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

std::string FREE::StatisticEntryDefinition::m_sControllerID [protected]

Definition at line 96 of file freStatisticEntryDefinition.h.

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

std::string FREE::StatisticEntryDefinition::m_sDescription [protected]

Definition at line 97 of file freStatisticEntryDefinition.h.

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

IDType FREE::StatisticEntryDefinition::m_RefID [protected]

Definition at line 98 of file freStatisticEntryDefinition.h.

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

---

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

• freStatisticEntryDefinition.h
• freStatisticEntryDefinition.cxx

---