anatomist::GlobalConfiguration Class Reference

This class stores global configuration settings, read by default from $HOME/.anatomist/config/settings.cfg. More...

#include <anatomist/application/globalConfig.h>

Inheritance diagram for anatomist::GlobalConfiguration:

Collaboration diagram for anatomist::GlobalConfiguration:

Public Member Functions
	GlobalConfiguration ()
virtual	~GlobalConfiguration ()
virtual std::string	configFilename (const std::string &initial)
	Builds a default config filename if not given. More...
virtual void	load (const std::string &filename="")
virtual void	apply ()
	applies config settings to the program More...
virtual void	update ()
	updates the config from the current program state More...
virtual void	save (const std::string &filename="")
void	registerLocalConfiguration (LocalConfiguration *cfg)
void	unregisterLocalConfiguration (LocalConfiguration *cfg)
Public Member Functions inherited from Tree
	Tree (bool allowChildren=true, const std::string &str="")
virtual	~Tree ()
virtual void	accept (TreeVisitor &visitor)
virtual void	const_accept (ConstTreeVisitor &visitor) const
virtual bool	check (const carto::SyntaxSet &syntax, std::set< std::string > &missing) const
std::set< Tree * >	getElementsWith (const std::string &, bool recurse=true) const
std::set< Tree * >	getElementsWith (const std::string &, const T &, bool recurse=true) const
virtual size_t	size () const __attribute__((__deprecated__))
virtual size_t	childrenSize () const
Public Member Functions inherited from carto::SyntaxedObject< class >
	SyntaxedObject (const std::string &s)
	SyntaxedObject (const SyntaxedObject &x)
	SyntaxedObject (const SyntaxedObject< PropertySet > &x)
Public Member Functions inherited from BaseTree
	BaseTree (bool allowsChildren=true)
virtual	~BaseTree ()
const std::list< BaseTree * > &	children () const
bool	getAllowsChildren () const
BaseTree *	getChildAt (unsigned childIndex) const
int	getIndex (BaseTree *node) const
BaseTree *	getParent () const
BaseTree *	getTopParent ()
const BaseTree *	getTopParent () const
bool	isLeaf () const
void	insert (BaseTree *child, int index=-1)
void	remove (unsigned index)
void	remove (BaseTree *node)
void	removeFromParent ()
void	setParent (BaseTree *newParent)
void	clear ()
const_iterator	begin () const
const_iterator	end () const
const_reverse_iterator	rbegin () const
const_reverse_iterator	rend () const

Protected Member Functions
virtual void	initSyntax ()

Protected Attributes
std::string	_filename
carto::SyntaxSet	_syntax
std::list< LocalConfiguration * >	_configs

Additional Inherited Members
Public Types inherited from carto::SyntaxedObject< class >
typedef internal::SyntaxedObjectSwitch< T, SUPERSUBCLASS(Interface, T)>::ContentType	ContentType
Public Types inherited from BaseTree
typedef std::list< BaseTree * >::iterator	iterator
typedef std::list< BaseTree * >::const_iterator	const_iterator
typedef std::list< BaseTree * >::reverse_iterator	reverse_iterator
typedef std::list< BaseTree * >::const_reverse_iterator	const_reverse_iterator

Detailed Description

This class stores global configuration settings, read by default from $HOME/.anatomist/config/settings.cfg.

Definition at line 52 of file globalConfig.h.

Constructor & Destructor Documentation

GlobalConfiguration()

anatomist::GlobalConfiguration::GlobalConfiguration

(

)

~GlobalConfiguration()

virtual anatomist::GlobalConfiguration::~GlobalConfiguration ( )

virtual

Member Function Documentation

apply()

virtual void anatomist::GlobalConfiguration::apply ( )

virtual

applies config settings to the program

configFilename()

virtual std::string anatomist::GlobalConfiguration::configFilename ( const std::string &  initial )

virtual

Builds a default config filename if not given.

If initial is not empty, simply returns it. If initial is empty, returns the default path ( ~/.anatomist/config/settings.cfg )

initSyntax()

virtual void anatomist::GlobalConfiguration::initSyntax ( )

protectedvirtual

load()

virtual void anatomist::GlobalConfiguration::load ( const std::string &  filename = "" )

virtual

registerLocalConfiguration()

void anatomist::GlobalConfiguration::registerLocalConfiguration

(

LocalConfiguration *

cfg

)

save()

virtual void anatomist::GlobalConfiguration::save ( const std::string &  filename = "" )

virtual

unregisterLocalConfiguration()

void anatomist::GlobalConfiguration::unregisterLocalConfiguration

(

LocalConfiguration *

cfg

)

update()

virtual void anatomist::GlobalConfiguration::update ( )

virtual

updates the config from the current program state

Member Data Documentation

_configs

std::list<LocalConfiguration *> anatomist::GlobalConfiguration::_configs

protected

Definition at line 78 of file globalConfig.h.

_filename

std::string anatomist::GlobalConfiguration::_filename

protected

Definition at line 76 of file globalConfig.h.

_syntax

carto::SyntaxSet anatomist::GlobalConfiguration::_syntax

protected

Definition at line 77 of file globalConfig.h.

---

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

• anatomist/application/globalConfig.h