FREE::StatisticValueDefinition Class Reference
[Statistics]

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

#include <freStatisticValueDefinition.h>

Inheritance diagram for FREE::StatisticValueDefinition:

[legend]

Collaboration diagram for FREE::StatisticValueDefinition:

[legend]

List of all members.

Public Types
typedef StatisticValueDefinition	Self
typedef itk::LightObject	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef unsigned long	IDType
Public Member Functions
	itkTypeMacro (StatisticValueDefinition, XMLStreamObject)
	itkNewMacro (StatisticValueDefinition)
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	SetType (const std::string &sType)
const std::string &	GetType () const
void	SetRefID (const IDType &id)
const IDType &	GetRefID () const
virtual StatisticValueDefinition &	operator= (const StatisticValueDefinition &rEntry)
Protected Member Functions
	StatisticValueDefinition ()
virtual	~StatisticValueDefinition ()
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_sDescription
std::string	m_sType
IDType	m_RefID

---

Detailed Description

Class contains the dictionary information of one value.

StatisticValueDefinition is used to store general information about a statistic value logged in the statistic.

Definition at line 44 of file freStatisticValueDefinition.h.

---

Member Typedef Documentation

typedef StatisticValueDefinition FREE::StatisticValueDefinition::Self

Definition at line 47 of file freStatisticValueDefinition.h.

typedef itk::LightObject FREE::StatisticValueDefinition::Superclass

Definition at line 48 of file freStatisticValueDefinition.h.

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

Definition at line 49 of file freStatisticValueDefinition.h.

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

Definition at line 50 of file freStatisticValueDefinition.h.

typedef unsigned long FREE::StatisticValueDefinition::IDType

Definition at line 55 of file freStatisticValueDefinition.h.

---

Constructor & Destructor Documentation

FREE::StatisticValueDefinition::StatisticValueDefinition

(

)

[protected]

Definition at line 50 of file freStatisticValueDefinition.cxx.

References Reset().

Here is the call graph for this function:

FREE::StatisticValueDefinition::~StatisticValueDefinition

(

)

[protected, virtual]

Definition at line 56 of file freStatisticValueDefinition.cxx.

---

Member Function Documentation

FREE::StatisticValueDefinition::itkTypeMacro	(	StatisticValueDefinition	,
		XMLStreamObject
	)

FREE::StatisticValueDefinition::itkNewMacro

(

StatisticValueDefinition

)

void FREE::StatisticValueDefinition::Reset

(

)

[virtual]

Resets the value to an empty string and undefined type.

Reimplemented from FREE::XMLStreamObject.

Definition at line 61 of file freStatisticValueDefinition.cxx.

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

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

Here is the call graph for this function:

void FREE::StatisticValueDefinition::SetName

(

const std::string &

sName

)

[inline]

Definition at line 60 of file freStatisticValueDefinition.h.

References m_sName.

Referenced by operator=().

const std::string& FREE::StatisticValueDefinition::GetName

(

)

const [inline]

Definition at line 63 of file freStatisticValueDefinition.h.

References m_sName.

Referenced by operator=().

void FREE::StatisticValueDefinition::SetIDPath

(

const std::string &

sIDPath

)

[inline]

Definition at line 66 of file freStatisticValueDefinition.h.

References m_sIDPath.

Referenced by operator=().

const std::string& FREE::StatisticValueDefinition::GetIDPath

(

)

const [inline]

Definition at line 69 of file freStatisticValueDefinition.h.

References m_sIDPath.

Referenced by operator=().

void FREE::StatisticValueDefinition::SetDescription

(

const std::string &

sDescription

)

[inline]

Definition at line 72 of file freStatisticValueDefinition.h.

References m_sDescription.

Referenced by operator=().

const std::string& FREE::StatisticValueDefinition::GetDescription

(

)

const [inline]

Definition at line 75 of file freStatisticValueDefinition.h.

References m_sDescription.

Referenced by operator=().

void FREE::StatisticValueDefinition::SetType

(

const std::string &

sType

)

[inline]

Definition at line 78 of file freStatisticValueDefinition.h.

References m_sType.

Referenced by operator=().

const std::string& FREE::StatisticValueDefinition::GetType

(

)

const [inline]

Definition at line 81 of file freStatisticValueDefinition.h.

References m_sType.

Referenced by operator=().

void FREE::StatisticValueDefinition::SetRefID

(

const IDType &

id

)

[inline]

Definition at line 84 of file freStatisticValueDefinition.h.

References m_RefID.

Referenced by operator=().

const IDType& FREE::StatisticValueDefinition::GetRefID

(

)

const [inline]

Definition at line 87 of file freStatisticValueDefinition.h.

References m_RefID.

Referenced by FREE::StatisticDictionary::GetValueDefinitionIDByName(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextLevel(), operator=(), FREE::VersorTransformOptimizerController::SetStatisticEntryMainComponent(), FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::SetStatisticEntryMainComponent(), FREE::StoreableMediaControllerBase< TMedia >::SetStatisticEntryMainComponent(), FREE::SPSASOOptimizerController::SetStatisticEntryMainComponent(), FREE::SPSAOptimizerController::SetStatisticEntryMainComponent(), FREE::RegStepGradDescOptimizerControllerBase< TOptimizer >::SetStatisticEntryMainComponent(), FREE::PrecisionSOMetricController::SetStatisticEntryMainComponent(), FREE::PowellSOOptimizerController::SetStatisticEntryMainComponent(), FREE::PowellOptimizerController::SetStatisticEntryMainComponent(), FREE::PointSupportedMetricControllerBase< ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::PointSetType >::SetStatisticEntryMainComponent(), FREE::OptimizerControllerBase< TControlledOptimizer >::SetStatisticEntryMainComponent(), FREE::OnePlusOneEvolutionarySOOptimizerController::SetStatisticEntryMainComponent(), FREE::OnePlusOneEvolutionaryOptimizerController::SetStatisticEntryMainComponent(), FREE::MVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::SetStatisticEntryMainComponent(), FREE::LimitedAxisAmoebaSOOptimizerController::SetStatisticEntryMainComponent(), FREE::LBFGSOptimizerController::SetStatisticEntryMainComponent(), FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >::SetStatisticEntryMainComponent(), FREE::ImageDifferenceSOMetricControllerBase< FREE::ConstrainedImageDifferenceSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ImageClassificationSOMetricControllerBase< FREE::ConstrainedImageClassificationSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::GradientDescentOptimizerController::SetStatisticEntryMainComponent(), FREE::FEMRegistrationControllerBase< FREE::FEMRegistrationProcessor >::SetStatisticEntryMainComponent(), FREE::ExhaustiveSOOptimizerController::SetStatisticEntryMainComponent(), FREE::ExhaustiveOptimizerController::SetStatisticEntryMainComponent(), FREE::EvolutionaryStrategySOOptimizerController::SetStatisticEntryMainComponent(), FREE::EvolutionaryStrategyOptimizerController::SetStatisticEntryMainComponent(), FREE::ESCMAMutationController::SetStatisticEntryMainComponent(), FREE::ContinuousLBFGSOptimizerController::SetStatisticEntryMainComponent(), FREE::ConstrainedOnePlusOneEvolutionarySOOptimizerController::SetStatisticEntryMainComponent(), FREE::ConstrainedImageDifferenceSOMetricControllerBase< FREE::ConstrainedImageDifferenceSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ConstrainedImageClassificationSOMetricControllerBase< FREE::ConstrainedImageClassificationSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ConstrainedAccuracySOMetricControllerBase< FREE::ConstrainedAccuracySOMetric< 3 > >::SetStatisticEntryMainComponent(), FREE::ConsistencySOMetricControllerBase< FREE::ConsistencyRegistrationMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ConjugateGradientOptimizerController::SetStatisticEntryMainComponent(), FREE::AmoebaSOOptimizerController::SetStatisticEntryMainComponent(), FREE::AmoebaOptimizerController::SetStatisticEntryMainComponent(), and FREE::AccuracySOMetricControllerBase< FREE::ConstrainedAccuracySOMetric< 3 > >::SetStatisticEntryMainComponent().

StatisticValueDefinition & FREE::StatisticValueDefinition::operator=

(

const StatisticValueDefinition &

rEntry

)

[virtual]

Assignment operator.

Implementation of FREE::StatisticValueDefinition ///////////////////

Definition at line 34 of file freStatisticValueDefinition.cxx.

References GetDescription(), GetIDPath(), GetName(), GetRefID(), GetType(), Reset(), SetDescription(), SetIDPath(), SetName(), SetRefID(), and SetType().

Here is the call graph for this function:

void FREE::StatisticValueDefinition::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 freStatisticValueDefinition.cxx.

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

Here is the call graph for this function:

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

Reimplemented from FREE::XMLStreamObject.

Definition at line 84 of file freStatisticValueDefinition.cxx.

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

Here is the call graph for this function:

---

Member Data Documentation

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

Definition at line 94 of file freStatisticValueDefinition.h.

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

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

Definition at line 95 of file freStatisticValueDefinition.h.

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

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

Definition at line 96 of file freStatisticValueDefinition.h.

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

std::string FREE::StatisticValueDefinition::m_sType [protected]

Definition at line 97 of file freStatisticValueDefinition.h.

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

IDType FREE::StatisticValueDefinition::m_RefID [protected]

Definition at line 98 of file freStatisticValueDefinition.h.

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

---

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

• freStatisticValueDefinition.h
• freStatisticValueDefinition.cxx

---