DtMultiConfigVariable< T > Class Template Reference

Inheritance diagram for DtMultiConfigVariable< T >:

Collaboration diagram for DtMultiConfigVariable< T >:

Public Member Functions
	DtMultiConfigVariable (DtVariableGroup *group, const DtString &aName, const DtString &itemName, const DtString &aDescription="", DtVariableScope aScope=DtBaseConfigVariable::DtScopeBoth, bool isRequired=false, const DtString &aShortcut="")
	Var CTOR, using Group pointer.
	DtMultiConfigVariable (DtVariableGroup &group, const DtString &aName, const DtString &itemName, const DtString &aDescription="", DtVariableScope aScope=DtBaseConfigVariable::DtScopeBoth, bool isRequired=false, const DtString &aShortcut="")
	Var CTOR, using Group reference.
virtual	~DtMultiConfigVariable ()
	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.
virtual const DtString &	name () const
	Get the Var's name.
void	setName (const DtString &name)
const std::vector< T > &	values () const
void	setValues (const std::vector< T > &aValue)
void	addValue (T aValue)
void	removeValue (T aValue)
void	clearValues ()
const DtString &	shortcut () const
void	setShortcut (const DtString &aShortcut)
Public Member Functions inherited from DtBaseConfigVariable
	DtBaseConfigVariable (DtVariableGroup *settings, DtVariableScope aScope, const DtString &aDescription)
	CTOR.
virtual	~DtBaseConfigVariable ()
	DTOR.
DtVariableScope	scope () const
	Get the scope of this variable.
const DtString &	description () const
bool	inConfigFile () const
	Is this var used in the config line.
bool	inCommandLine () const
	Is this var used in the command line.
bool	isSet () const
	Check to see if the value has been set.

Protected Types
typedef DtVarType< T >::ArgType	ArgType

Protected Attributes
DtString	myName
DtString	myItemName
DtString	myShortcut
bool	myRequiredFlag
DtVariableGroup *	myGroup
std::vector< T >	myValues
Protected Attributes inherited from DtBaseConfigVariable
DtVariableScope	myScope
	My scope.
bool	mySetFlag
	Stores a flag to determine if this var has been set yet.
DtCmdLine::Arg *	myArg
	Stores the argument relating with this var.
DtString	myDescription
	Stores a description of the variable.

Additional Inherited Members
Public Types inherited from DtBaseConfigVariable
enum	DtVariableScope { DtScopeInternal, DtScopeConfigFile, DtScopeCommandLine, DtScopeBoth }
typedef std::set< DtString >	TypeSet
Static Public Member Functions inherited from DtBaseConfigVariable
static DtEnvValueSP	createSchemaDeclaration (DtEnvironment env, const DtString &name, const DtString &type)
static DtEnvValueSP	createSimpleSchemaType (DtEnvironment env, const DtString &typeName, const DtString &xsType)
	Help function for simple types.
static DtEnvValueSP	createComplexSchemaType (DtEnvironment env, const DtString &typeName, bool ordered, const std::list< DtBaseConfigVariable * > &members)
	Create a complex schema type.

Member Typedef Documentation

template<typename T >

typedef DtVarType<T>::ArgType DtMultiConfigVariable< T >::ArgType

protected

Constructor & Destructor Documentation

template<typename T >

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

Var CTOR, using Group pointer.

template<typename T >

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

Var CTOR, using Group reference.

template<typename T >

virtual DtMultiConfigVariable< T >::~DtMultiConfigVariable ( )

virtual

DTOR.

Member Function Documentation

template<typename T >

void DtMultiConfigVariable< T >::addValue

(

T

aValue

)

template<typename T >

void DtMultiConfigVariable< T >::clearValues

(

)

template<typename T >

virtual void DtMultiConfigVariable< T >::getCommandLineArg ( DtCmdLine::CmdLine &  )

virtual

Create a command line argument for the native value.

Implements DtBaseConfigVariable.

template<typename T >

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

virtual

Get Environment schema type.

Implements DtBaseConfigVariable.

template<typename T >

virtual DtEnvValueSP DtMultiConfigVariable< T >::getEnvironmentValue ( DtEnvironment  env )

virtual

Create an Environment Value from the native value.

Implements DtBaseConfigVariable.

template<typename T >

virtual bool DtMultiConfigVariable< T >::isRequired ( ) const

virtual

Get if the var is required.

Implements DtBaseConfigVariable.

template<typename T >

virtual const DtString& DtMultiConfigVariable< T >::name ( ) const

virtual

Get the Var's name.

Implements DtBaseConfigVariable.

template<typename T >

void DtMultiConfigVariable< T >::removeValue

(

T

aValue

)

template<typename T >

void DtMultiConfigVariable< T >::setName

(

const DtString &

name

)

template<typename T >

void DtMultiConfigVariable< T >::setShortcut

(

const DtString &

aShortcut

)

template<typename T >

void DtMultiConfigVariable< T >::setValues

(

const std::vector< T > &

aValue

)

template<typename T >

const DtString& DtMultiConfigVariable< T >::shortcut

(

)

const

template<typename T >

virtual DtString DtMultiConfigVariable< T >::type ( ) const

virtual

Get the Var's type.

Implements DtBaseConfigVariable.

template<typename T >

virtual void DtMultiConfigVariable< T >::updateFromCommandLineArg ( )

virtual

Update the native value from the command line argument.

Implements DtBaseConfigVariable.

template<typename T >

virtual void DtMultiConfigVariable< T >::updateFromEnvironment ( DtEnvironment  env )

virtual

Update the native value from the Environment Value.

Implements DtBaseConfigVariable.

template<typename T >

const std::vector<T>& DtMultiConfigVariable< T >::values

(

)

const

Member Data Documentation

template<typename T >

DtVariableGroup* DtMultiConfigVariable< T >::myGroup

protected

template<typename T >

DtString DtMultiConfigVariable< T >::myItemName

protected

template<typename T >

DtString DtMultiConfigVariable< T >::myName

protected

template<typename T >

bool DtMultiConfigVariable< T >::myRequiredFlag

protected

template<typename T >

DtString DtMultiConfigVariable< T >::myShortcut

protected

template<typename T >

std::vector<T> DtMultiConfigVariable< T >::myValues

protected

---

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

• multiVar.h