FREE::StatisticValue Class Reference
[Statistics]

Class contains a value of processing log entry. More...

#include <freStatisticValue.h>

Inheritance diagram for FREE::StatisticValue:

[legend]

Collaboration diagram for FREE::StatisticValue:

[legend]

List of all members.

Public Types
typedef StatisticValueDefinition::IDType	ReferenceIDType
Public Member Functions
std::string	GetValue () const
void	SetValue (const std::string &sValue)
ReferenceIDType	GetReferenceID () const
void	SetReferenceID (const ReferenceIDType &refID)
virtual StatisticValue &	operator= (const StatisticValue &value)
	StatisticValue (const std::string &sValue, const ReferenceIDType &refID=cUndefinedRef)
	StatisticValue (const StatisticValue &value)
virtual void	Reset ()
Static Public Attributes
static const ReferenceIDType	cUndefinedRef = 0
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	AttributesLoadProcessing (const AttributesType &rAttributes)
virtual void	SaveAttributes (AttributesSaveListType &rAttributes) const
Protected Attributes
std::string	m_sValue
ReferenceIDType	m_RefID

---

Detailed Description

Class contains a value of processing log entry.

StatisticValue is used to store a statistical value. This is used to gather statistical information of a process, so it can be used to evaluated the task (e.g. a registration).

Definition at line 39 of file freStatisticValue.h.

---

Member Typedef Documentation

typedef StatisticValueDefinition::IDType FREE::StatisticValue::ReferenceIDType

Definition at line 42 of file freStatisticValue.h.

---

Constructor & Destructor Documentation

FREE::StatisticValue::StatisticValue	(	const std::string &	sValue,
		const ReferenceIDType &	refID = cUndefinedRef
	)

Normal constructor.

Definition at line 74 of file freStatisticValue.cxx.

References SetReferenceID(), and SetValue().

Here is the call graph for this function:

FREE::StatisticValue::StatisticValue

(

const StatisticValue &

value

)

Copy constructor

Definition at line 81 of file freStatisticValue.cxx.

---

Member Function Documentation

std::string FREE::StatisticValue::GetValue

(

)

const

Definition at line 37 of file freStatisticValue.cxx.

References m_sValue.

Referenced by operator=().

void FREE::StatisticValue::SetValue

(

const std::string &

sValue

)

Definition at line 44 of file freStatisticValue.cxx.

References m_sValue.

Referenced by StatisticValue().

StatisticValue::ReferenceIDType FREE::StatisticValue::GetReferenceID

(

)

const

Definition at line 51 of file freStatisticValue.cxx.

References m_RefID.

Referenced by operator=().

void FREE::StatisticValue::SetReferenceID

(

const ReferenceIDType &

refID

)

Definition at line 58 of file freStatisticValue.cxx.

References m_RefID.

Referenced by StatisticValue().

StatisticValue & FREE::StatisticValue::operator=

(

const StatisticValue &

value

)

[virtual]

Assignment operator.

Definition at line 65 of file freStatisticValue.cxx.

References GetReferenceID(), GetValue(), m_RefID, and m_sValue.

Here is the call graph for this function:

void FREE::StatisticValue::Reset

(

)

[virtual]

Resets the value to an empty string and undefined type.

Reimplemented from FREE::XMLStreamObject.

Definition at line 88 of file freStatisticValue.cxx.

References cUndefinedRef, m_RefID, and m_sValue.

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

Reimplemented from FREE::XMLStreamObject.

Definition at line 96 of file freStatisticValue.cxx.

References m_sValue.

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

Reimplemented from FREE::XMLStreamObject.

Definition at line 103 of file freStatisticValue.cxx.

References m_sValue.

void FREE::StatisticValue::AttributesLoadProcessing

(

const AttributesType &

rAttributes

)

[protected, virtual]

Definition at line 111 of file freStatisticValue.cxx.

References cUndefinedRef, m_RefID, and FREE::Convert::ToInt().

Here is the call graph for this function:

void FREE::StatisticValue::SaveAttributes

(

AttributesSaveListType &

rAttributes

)

const [protected, virtual]

Definition at line 120 of file freStatisticValue.cxx.

References m_RefID, and FREE::Convert::ToStr().

Here is the call graph for this function:

---

Member Data Documentation

const StatisticValue::ReferenceIDType FREE::StatisticValue::cUndefinedRef = 0 [static]

Implementation of FREE::StatisticValue /////////////////////////////

Definition at line 43 of file freStatisticValue.h.

Referenced by AttributesLoadProcessing(), and Reset().

std::string FREE::StatisticValue::m_sValue [protected]

The value

Definition at line 77 of file freStatisticValue.h.

Referenced by GetValue(), operator=(), Reset(), SaveData(), SetValue(), and SubElementLoadProcessing().

ReferenceIDType FREE::StatisticValue::m_RefID [protected]

ID of the Type within the statistical legend

Definition at line 80 of file freStatisticValue.h.

Referenced by AttributesLoadProcessing(), GetReferenceID(), operator=(), Reset(), SaveAttributes(), and SetReferenceID().

---

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

• freStatisticValue.h
• freStatisticValue.cxx

---