#include <Parameter.h>

Inheritance diagram for karto::Parameter< T >:

Public Member Functions
	Parameter (ParameterDescription *pDescription, const T &rValue)

	Parameter (ParameterSet *pParameterSet, const karto::String &rName, const karto::String &rDisplayName, const karto::String &rDescription, const T &rValue)

Public Member Functions inherited from karto::AbstractParameter
	AbstractParameter (ParameterDescription pDescription, ParameterSet pParameterSet=NULL)

const karto::String &	GetDescription () const

const karto::String &	GetDisplayName () const

kt_int32s	GetFlags () const

const karto::String &	GetName () const

const ParameterDescription *	GetParameterDescription () const

ParameterDescription *	GetParameterDescription ()

Public Member Functions inherited from karto::Referenced
	Referenced ()

Protected Member Functions
kt_bool	CompareValue (const T &rValue)

virtual T &	GetDefaultValue ()

virtual const T &	GetValue () const

virtual const karto::String	GetValueAsString () const

virtual void	InitializeParameters ()

virtual void	SetDefaultValue (const T &rValue)

virtual void	SetToDefaultValue ()

virtual void	SetValue (const T &rValue)

virtual void	SetValueFromString (const karto::String &rStringValue)

Protected Member Functions inherited from karto::Referenced
kt_int32s	GetReferenceCount ()

kt_int32s	Reference () const

kt_int32s	Unreference () const

kt_int32s	UnreferenceNoDelete () const

Protected Attributes
T	m_Value

Protected Attributes inherited from karto::AbstractParameter
BasicEvent< EventArguments >	Changed

Private Member Functions
	KARTO_RTTI ()

const Parameter &	operator= (const Parameter &)

	Parameter (const Parameter &)

Private Attributes
T	m_DefaultValue

Detailed Description

template<typename T>
class karto::Parameter< T >

Parameter

Definition at line 436 of file Parameter.h.

Constructor & Destructor Documentation

template<typename T>

karto::Parameter< T >::Parameter	(	ParameterDescription *	pDescription,
		const T &	rValue
	)

inline

Parameter with the given description and given value

Parameters

pDescription	description of the parameter
rValue	parameter value

Definition at line 446 of file Parameter.h.

template<typename T>

karto::Parameter< T >::Parameter	(	ParameterSet *	pParameterSet,
		const karto::String &	rName,
		const karto::String &	rDisplayName,
		const karto::String &	rDescription,
		const T &	rValue
	)

inline

Parameter for the set of parameters with the given name, display name, description and value

Parameters

pParameterSet	set of parameters
rName	name of the parameter
rDisplayName	display name of the parameter
rDescription	description of the parameter
rValue	parameter value

Definition at line 461 of file Parameter.h.

template<typename T>

karto::Parameter< T >::Parameter ( const Parameter< T > & )

private

Member Function Documentation

template<typename T>

kt_bool karto::Parameter< T >::CompareValue ( const T & rValue )

inlineprotected

Compares if the given value is equal to current value

Parameters

rValue value to compare against

Returns: true if equal

Definition at line 566 of file Parameter.h.

template<typename T>

virtual T& karto::Parameter< T >::GetDefaultValue ( )

inlineprotectedvirtual

Gets the default value of parameter

Returns: parameter value

Definition at line 508 of file Parameter.h.

template<typename T>

virtual const T& karto::Parameter< T >::GetValue ( ) const

inlineprotectedvirtual

public: /** Gets the value of parameter

Returns: parameter value

Definition at line 483 of file Parameter.h.

template<typename T>

virtual const karto::String karto::Parameter< T >::GetValueAsString ( ) const

inlineprotectedvirtual

Gets value of parameter as string

Returns: string version of value

Implements karto::AbstractParameter.

Reimplemented in karto::ParameterEnum.

Definition at line 526 of file Parameter.h.

template<typename T>

virtual void karto::Parameter< T >::InitializeParameters ( )

inlineprotectedvirtual

Initialize parameters

Reimplemented from karto::AbstractParameter.

Definition at line 556 of file Parameter.h.

template<typename T>

karto::Parameter< T >::KARTO_RTTI ( )

private

template<typename T>

const Parameter& karto::Parameter< T >::operator= ( const Parameter< T > & )

private

template<typename T>

virtual void karto::Parameter< T >::SetDefaultValue ( const T & rValue )

inlineprotectedvirtual

Sets the default value of parameter

Parameters

rValue value to set as default

Definition at line 517 of file Parameter.h.

template<typename T>

virtual void karto::Parameter< T >::SetToDefaultValue ( )

inlineprotectedvirtual

Set parameter value to default value

Implements karto::AbstractParameter.

Definition at line 547 of file Parameter.h.

template<typename T>

virtual void karto::Parameter< T >::SetValue ( const T & rValue )

inlineprotectedvirtual

Sets the value of parameter

Parameters

rValue value to set parameter to

Definition at line 492 of file Parameter.h.

template<typename T>

virtual void karto::Parameter< T >::SetValueFromString ( const karto::String & rStringValue )

inlineprotectedvirtual

Sets the value of parameter from string

Parameters

rStringValue string

Implements karto::AbstractParameter.

Reimplemented in karto::ParameterEnum.

Definition at line 535 of file Parameter.h.

Member Data Documentation

template<typename T>

T karto::Parameter< T >::m_DefaultValue

private

Parameter default value

Definition at line 586 of file Parameter.h.

template<typename T>

T karto::Parameter< T >::m_Value

protected

Parameter value

Definition at line 580 of file Parameter.h.

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

Parameter.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

template<typename T> class karto::Parameter< T >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename T>
class karto::Parameter< T >