DtApplicationSettings Class Reference

Inheritance diagram for DtApplicationSettings:

Collaboration diagram for DtApplicationSettings:

Public Member Functions
	DtApplicationSettings (const DtString &applicationName, const DtString &appVersion, const DtString &implicitGroupName="settings")
virtual	~DtApplicationSettings ()
void	setChangeOnce (bool flag)
virtual bool	changeOnce () const
	What does this do????
void	parseCommandLine (int argc, char **argv, bool pressAnyKey=false)
bool	loadConfigFile (const DtString &filename)
bool	loadMtlFile (const DtString &filename)
bool	loadXmlFile (const DtString &filename)
bool	saveConfigFile (const DtString &filename, const DtString &schemaName, bool generateSchemaFile=false)
void	generateConfigFileSchema (const DtString &filename) const
void	generateElements (DtEnvironment worker) const
void	addBaseVar (DtBaseConfigVariable *var)
const DtString &	applicationName () const
const DtString &	applicationVersion () const
Public Member Functions inherited from DtVariableGroup
	DtVariableGroup (DtVariableGroup *parent, const DtString &groupName, const DtString &groupType="", const DtString &aDescription="")
virtual	~DtVariableGroup ()
virtual void	addBaseVariable (DtBaseConfigVariable *var)
virtual const DtString &	name () const
	Get the group's name.
virtual bool	isRequired () const
	Get if the group is required.
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.
virtual DtString	type () const
	Get the Var's type.
DtEnvValueSP	getGroupValue (DtEnvironment env)
Public Member Functions inherited from DtBaseConfigVariable
	DtBaseConfigVariable (DtVariableGroup *settings, DtVariableScope aScope, const DtString &aDescription)
	CTOR.
virtual	~DtBaseConfigVariable ()
	DTOR.
DtBaseConfigVariable &	operator= (const DtBaseConfigVariable &other)
	Assignment operator.
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 Member Functions
bool	readFileIntoEnvironment (const DtString &filename, DtEnvReader &reader)
	DtApplicationSettings (const DtApplicationSettings &other)
	Copy CTOR (not implemented).
DtApplicationSettings &	operator= (const DtApplicationSettings &other)
	Assignment operator (not implemented).
Protected Member Functions inherited from DtVariableGroup
	DtVariableGroup (const DtVariableGroup &other)
	Copy CTOR (not implemented).
DtVariableGroup &	operator= (const DtVariableGroup &other)
	Assignment operator (not implemented).
Protected Member Functions inherited from DtBaseConfigVariable
	DtBaseConfigVariable (const DtBaseConfigVariable &other)
	Copy CTOR (not implemented).

Protected Attributes
DtString	myAppName
DtString	myAppVersion
DtVariableGroup *	myRootGroup
bool	myChangeOnceFlag
Protected Attributes inherited from DtVariableGroup
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.
Protected Types inherited from DtVariableGroup
typedef std::list < DtBaseConfigVariable * >	VariableList

Constructor & Destructor Documentation

DtApplicationSettings::DtApplicationSettings	(	const DtString &	applicationName,
		const DtString &	appVersion,
		const DtString &	implicitGroupName = "settings"
	)

virtual DtApplicationSettings::~DtApplicationSettings ( )

virtual

DtApplicationSettings::DtApplicationSettings ( const DtApplicationSettings &  other )

protected

Copy CTOR (not implemented).

Member Function Documentation

void DtApplicationSettings::addBaseVar

(

DtBaseConfigVariable *

var

)

const DtString& DtApplicationSettings::applicationName

(

)

const

const DtString& DtApplicationSettings::applicationVersion

(

)

const

virtual bool DtApplicationSettings::changeOnce ( ) const

virtual

What does this do????

Reimplemented from DtVariableGroup.

void DtApplicationSettings::generateConfigFileSchema

(

const DtString &

filename

)

const

void DtApplicationSettings::generateElements

(

DtEnvironment

worker

)

const

bool DtApplicationSettings::loadConfigFile

(

const DtString &

filename

)

bool DtApplicationSettings::loadMtlFile

(

const DtString &

filename

)

bool DtApplicationSettings::loadXmlFile

(

const DtString &

filename

)

DtApplicationSettings& DtApplicationSettings::operator= ( const DtApplicationSettings &  other )

protected

Assignment operator (not implemented).

void DtApplicationSettings::parseCommandLine	(	int	argc,
		char **	argv,
		bool	pressAnyKey = false
	)

bool DtApplicationSettings::readFileIntoEnvironment ( const DtString &  filename, DtEnvReader &  reader  )

protected

bool DtApplicationSettings::saveConfigFile	(	const DtString &	filename,
		const DtString &	schemaName,
		bool	generateSchemaFile = false
	)

void DtApplicationSettings::setChangeOnce

(

bool

flag

)

Member Data Documentation

DtString DtApplicationSettings::myAppName

protected

DtString DtApplicationSettings::myAppVersion

protected

bool DtApplicationSettings::myChangeOnceFlag

protected

DtVariableGroup* DtApplicationSettings::myRootGroup

protected

---

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

• applicationSettings.h