DtConfigVariable< T > Class Template Reference

Inheritance diagram for DtConfigVariable< T >:

Collaboration diagram for DtConfigVariable< T >:

List of all members.

Public Member Functions
	DtConfigVariable (DtVariableGroup *group, const DtString &aName, T aDefault, const DtString &aDescription="", DtVariableScope aScope=DtBaseConfigVariable::DtScopeBoth, bool isRequired=false, const DtString &aShortcut="")
	Var CTOR, using Group pointer.
	DtConfigVariable (DtVariableGroup &group, const DtString &aName, T aDefault, const DtString &aDescription="", DtVariableScope aScope=DtBaseConfigVariable::DtScopeBoth, bool isRequired=false, const DtString &aShortcut="")
	Var CTOR, using Group reference.
virtual	~DtConfigVariable ()
	DTOR.
virtual void	getCommandLineArg (DtCmdLine::CmdLine &)
	Create a command line argument for the native value.
virtual void	updateFromCommandLineArg ()
	Update the native value from the command line argument.
virtual void	getEnvironmentSchemaType (DtEnvironment env, TypeSet &usedTypes) const
	Get Environment schema type.
virtual DtEnvValueSP	getEnvironmentValue (DtEnvironment env)
	Create an Environment Value from the native value.
virtual void	updateFromEnvironment (DtEnvironment env)
	Update the native value from the Environment Value.
virtual DtString	type () const
	Get the Var's type.
virtual bool	isRequired () const
	Get if the var is required.
T *	getInternalPtrValue ()
virtual const DtString &	name () const
	Get the Var's name.
void	setName (const DtString &name)
T	value () const
void	setValue (T aValue)
const DtString &	shortcut () const
void	setShortcut (const DtString &aShortcut)
T	defaultValue () const
	Get/Set the default value.
void	setDefaultValue (T aDefault)
	Get/Set the default value.
Protected Types
typedef DtVarType< T >::ArgType	ArgType
Protected Attributes
DtString	myName
DtString	myShortcut
bool	myRequiredFlag
DtVariableGroup *	myGroup
T	myDefault
T	myValue

template<typename T>
class DtConfigVariable< T >

---

Member Typedef Documentation

template<typename T>

typedef DtVarType<T>::ArgType DtConfigVariable< T >::ArgType [protected]

---

Constructor & Destructor Documentation

template<typename T>

DtConfigVariable< T >::DtConfigVariable	(	DtVariableGroup *	group,
		const DtString &	aName,
		T	aDefault,
		const DtString &	aDescription = "",
		DtVariableScope	aScope = DtBaseConfigVariable::DtScopeBoth,
		bool	isRequired = false,
		const DtString &	aShortcut = ""
	)

Var CTOR, using Group pointer.

template<typename T>

DtConfigVariable< T >::DtConfigVariable	(	DtVariableGroup &	group,
		const DtString &	aName,
		T	aDefault,
		const DtString &	aDescription = "",
		DtVariableScope	aScope = DtBaseConfigVariable::DtScopeBoth,
		bool	isRequired = false,
		const DtString &	aShortcut = ""
	)

Var CTOR, using Group reference.

template<typename T>

virtual DtConfigVariable< T >::~DtConfigVariable

(

)

[virtual]

DTOR.

---

Member Function Documentation

template<typename T>

T DtConfigVariable< T >::defaultValue

(

)

const

Get/Set the default value.

template<typename T>

virtual void DtConfigVariable< T >::getCommandLineArg

(

DtCmdLine::CmdLine &

)

[virtual]

Create a command line argument for the native value.

Implements DtBaseConfigVariable.

template<typename T>

virtual void DtConfigVariable< T >::getEnvironmentSchemaType	(	DtEnvironment	env,
		TypeSet &	usedTypes
	)		const [virtual]

Get Environment schema type.

Implements DtBaseConfigVariable.

template<typename T>

virtual DtEnvValueSP DtConfigVariable< T >::getEnvironmentValue

(

DtEnvironment

env

)

[virtual]

Create an Environment Value from the native value.

Implements DtBaseConfigVariable.

template<typename T>

T* DtConfigVariable< T >::getInternalPtrValue

(

)

Referenced by DtMtlEnvironment::registerConfigVar().

template<typename T>

virtual bool DtConfigVariable< T >::isRequired

(

)

const [virtual]

Get if the var is required.

Implements DtBaseConfigVariable.

template<typename T>

virtual const DtString& DtConfigVariable< T >::name

(

)

const [virtual]

Get the Var's name.

Implements DtBaseConfigVariable.

Referenced by DtMtlEnvironment::registerConfigVar().

template<typename T>

void DtConfigVariable< T >::setDefaultValue

(

T

aDefault

)

Get/Set the default value.

template<typename T>

void DtConfigVariable< T >::setName

(

const DtString &

name

)

template<typename T>

void DtConfigVariable< T >::setShortcut

(

const DtString &

aShortcut

)

template<typename T>

void DtConfigVariable< T >::setValue

(

T

aValue

)

template<typename T>

const DtString& DtConfigVariable< T >::shortcut

(

)

const

template<typename T>

virtual DtString DtConfigVariable< T >::type

(

)

const [virtual]

Get the Var's type.

Implements DtBaseConfigVariable.

template<typename T>

virtual void DtConfigVariable< T >::updateFromCommandLineArg

(

)

[virtual]

Update the native value from the command line argument.

Implements DtBaseConfigVariable.

template<typename T>

virtual void DtConfigVariable< T >::updateFromEnvironment

(

DtEnvironment

env

)

[virtual]

Update the native value from the Environment Value.

Implements DtBaseConfigVariable.

template<typename T>

T DtConfigVariable< T >::value

(

)

const

---

Member Data Documentation

template<typename T>

T DtConfigVariable< T >::myDefault [protected]

template<typename T>

DtVariableGroup* DtConfigVariable< T >::myGroup [protected]

template<typename T>

DtString DtConfigVariable< T >::myName [protected]

template<typename T>

bool DtConfigVariable< T >::myRequiredFlag [protected]

template<typename T>

DtString DtConfigVariable< T >::myShortcut [protected]

template<typename T>

T DtConfigVariable< T >::myValue [protected]

---

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

• configVar.h