DtVariableGroup Class Reference

Represents a group of variables. More...

Inheritance diagram for DtVariableGroup:

Collaboration diagram for DtVariableGroup:

Public Member Functions
	DtVariableGroup (DtVariableGroup *parent, const DtString &groupName, const DtString &groupType="", const DtString &aDescription="")
virtual	~DtVariableGroup ()
virtual void	addBaseVariable (DtBaseConfigVariable *var)
virtual bool	changeOnce () const
	What does this do????
virtual bool	isRequired () const
	Get if the group is required.
virtual const DtString &	name () const
	Get the group's name.
virtual DtString	type () const
	Get the Var's type.
virtual void	getCommandLineArg (DtCmdLine::CmdLine &cmdLine)
	Get the command line arguments.
virtual void	updateFromCommandLineArg ()
	Update the value by its argument.
virtual void	getEnvironmentSchemaType (DtEnvironment env, TypeSet &usedTypes) const
	Get an environment value which represents the XML scheme type.
virtual DtEnvValueSP	getEnvironmentValue (DtEnvironment env)
	Get an environment value which represent the value of the var.
virtual void	updateFromEnvironment (DtEnvironment env)
	Synchronize the var with an environment.
DtEnvValueSP	getGroupValue (DtEnvironment env)
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 std::list < DtBaseConfigVariable * >	VariableList

Protected Attributes
DtString	myName
DtString	myType
DtVariableGroup *	myParent
VariableList	myVars
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.

Detailed Description

Represents a group of variables.

Member Typedef Documentation

typedef std::list<DtBaseConfigVariable*> DtVariableGroup::VariableList

protected

Constructor & Destructor Documentation

DtVariableGroup::DtVariableGroup	(	DtVariableGroup *	parent,
		const DtString &	groupName,
		const DtString &	groupType = "",
		const DtString &	aDescription = ""
	)

virtual DtVariableGroup::~DtVariableGroup ( )

virtual

Member Function Documentation

virtual void DtVariableGroup::addBaseVariable ( DtBaseConfigVariable *  var )

virtual

virtual bool DtVariableGroup::changeOnce ( ) const

virtual

What does this do????

Reimplemented in DtApplicationSettings.

virtual void DtVariableGroup::getCommandLineArg ( DtCmdLine::CmdLine &  cmdLine )

virtual

Get the command line arguments.

Implements DtBaseConfigVariable.

virtual void DtVariableGroup::getEnvironmentSchemaType ( DtEnvironment  env, TypeSet &  usedTypes  ) const

virtual

Get an environment value which represents the XML scheme type.

Implements DtBaseConfigVariable.

virtual DtEnvValueSP DtVariableGroup::getEnvironmentValue ( DtEnvironment  env )

virtual

Get an environment value which represent the value of the var.

If the var type does not support environment representation a NULL smart pointer should be returned.

Implements DtBaseConfigVariable.

DtEnvValueSP DtVariableGroup::getGroupValue

(

DtEnvironment

env

)

virtual bool DtVariableGroup::isRequired ( ) const

virtual

Get if the group is required.

Implements DtBaseConfigVariable.

virtual const DtString& DtVariableGroup::name ( ) const

virtual

Get the group's name.

Implements DtBaseConfigVariable.

virtual DtString DtVariableGroup::type ( ) const

virtual

Get the Var's type.

Implements DtBaseConfigVariable.

virtual void DtVariableGroup::updateFromCommandLineArg ( )

virtual

Update the value by its argument.

This function will not be called if getArg returns NULL.

Implements DtBaseConfigVariable.

virtual void DtVariableGroup::updateFromEnvironment ( DtEnvironment  env )

virtual

Synchronize the var with an environment.

This function will not be called if getEnvironmentValue() returns NULL.

Implements DtBaseConfigVariable.

Member Data Documentation

DtString DtVariableGroup::myName

protected

DtVariableGroup* DtVariableGroup::myParent

protected

DtString DtVariableGroup::myType

protected

VariableList DtVariableGroup::myVars

protected

---

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

• varGroup.h