makVrv::DtSettings Class Reference

The settings object is an abstract class for storing data which is typically gotten from a command line, or configuration file. More...

Public Types
typedef std::list< DtSettings * >	SettingsList
	List of settings.

Public Member Functions
	DtSettings ()
	Default CTOR.
virtual	~DtSettings ()
	DTOR.
void	processCommandLine (int argc, char **argv)
	Calls parseCommandLine, on myself and all my sub settings.
virtual void	loadConfigFile (const std::string &filename)=0
	Abstract load a config file function.
virtual void	saveConfigFile (const std::string &filename)=0
	Abstract save a config file function.
virtual void	addSubsettings (DtSettings *subSettings)
	Add a sub settings object.
virtual void	removeSubsettings (DtSettings *subSettings)
	Remove a sub settings object.
const SettingsList &	subSettings () const
	Get the current sub settings.
virtual void	lockSettings ()
	Make it so the setting can't change.
virtual void	unlockSettings ()
	Make it so the setting can change.
virtual bool	isLocked () const
	Check to see if the settings are locked.

Protected Member Functions
virtual void	parseCommandLine (int argc, char **argv)=0
	Abstract parse command line function.

Protected Attributes
bool	myLockFlag
SettingsList	mySettings

Detailed Description

The settings object is an abstract class for storing data which is typically gotten from a command line, or configuration file.

Member Typedef Documentation

typedef std::list<DtSettings*> makVrv::DtSettings::SettingsList

List of settings.

Constructor & Destructor Documentation

makVrv::DtSettings::DtSettings

(

)

Default CTOR.

virtual makVrv::DtSettings::~DtSettings ( )

virtual

DTOR.

Member Function Documentation

void makVrv::DtSettings::processCommandLine	(	int	argc,
		char **	argv
	)

Calls parseCommandLine, on myself and all my sub settings.

virtual void makVrv::DtSettings::loadConfigFile ( const std::string &  filename )

pure virtual

Abstract load a config file function.

virtual void makVrv::DtSettings::saveConfigFile ( const std::string &  filename )

pure virtual

Abstract save a config file function.

virtual void makVrv::DtSettings::addSubsettings ( DtSettings *  subSettings )

virtual

Add a sub settings object.

virtual void makVrv::DtSettings::removeSubsettings ( DtSettings *  subSettings )

virtual

Remove a sub settings object.

const SettingsList& makVrv::DtSettings::subSettings

(

)

const

Get the current sub settings.

virtual void makVrv::DtSettings::lockSettings ( )

virtual

Make it so the setting can't change.

virtual void makVrv::DtSettings::unlockSettings ( )

virtual

Make it so the setting can change.

virtual bool makVrv::DtSettings::isLocked ( ) const

virtual

Check to see if the settings are locked.

virtual void makVrv::DtSettings::parseCommandLine ( int  argc, char **  argv  )

protectedpure virtual

Abstract parse command line function.

Member Data Documentation

bool makVrv::DtSettings::myLockFlag

protected

SettingsList makVrv::DtSettings::mySettings

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtSettings.h