ArConfig Class Reference

Stores configuration information which may be read to and from files or other sources. More...

#include <ArConfig.h>

Inherits ArHasFileName.

Inherited by ArRobotParams.

Classes
class	ProcessFileCBType
	This class's job is to make the two functor types largely look like the same one from the code's perspective, this is so we can store them both in the same map for order of operations purposes. More...

Public Member Functions
bool	addComment (const char *comment, const char *sectionName="", ArPriority::Priority priority=ArPriority::NORMAL)
	Command to add a new comment to the given section with given priority. More...
bool	addParam (const ArConfigArg &arg, const char *sectionName="", ArPriority::Priority priority=ArPriority::NORMAL, const char *displayHint=NULL, ArConfigArg::RestartLevel restart=ArConfigArg::NO_RESTART)
	Command to add a parameter to the given section with given priority. More...
bool	addParamAsIs (const ArConfigArg &arg, const char *sectionName="")
	Adds a parameter that has all the other information on it already set. More...
void	addProcessFileCB (ArRetFunctor< bool > *functor, int priority=0)
	Adds a callback to be invoked when the configuration is loaded or reloaded. More...
void	addProcessFileCB (ArRetFunctor2< bool, char *, size_t > *functor, int priority=0)
	Adds a callback to be invoked when the configuration is loaded or reloaded.... More...
void	addProcessFileWithErrorCB (ArRetFunctor2< bool, char *, size_t > *functor, int priority=0)
	Adds a callback to be invoked when the configuration is loaded or reloaded, which may also receive error messages. More...
bool	addSection (const char *categoryName, const char *sectionName, const char *sectionDescription)
	Command to add a section and its description to the specified category. More...
bool	addSectionFlags (const char *sectionName, const char *flags)
	adds a flag to a section More...
void	addSectionNotToParse (const char *section)
	Adds a section for this config to always skip.
	ArConfig (const char *baseDirectory=NULL, bool noBlanksBetweenParams=false, bool ignoreBounds=false, bool failOnBadSection=false, bool saveUnknown=true)
	Constructor. More...
	ArConfig (const ArConfig &config)
	Copy constructor.
bool	callProcessFileCallBacks (bool continueOnError, char *errorBuffer=NULL, size_t errorBufferLen=0)
	Call the processFileCBs.
void	clearAll (void)
	Clears out all the section information and the processFileCBs.
void	clearAllValueSet (void)
	calls clearValueSet on the whole config (internal for default configs)
void	clearSections (void)
	Clears out all the section information.
virtual void	copyAndDetach (const ArConfig &config)
	Copies the given config to this one, detaching any pointers so they are not shared.
ArConfigSection *	findSection (const char *sectionName) const
	Find the section with the given name. More...
const char *	getBaseDirectory (void) const
	Get the base directory.
std::list< std::string >	getCategoryNames () const
	Returns the list of categories contained in this config.
const char *	getFileName (void) const
	Get the file name we loaded.
bool	getNoBlanksBetweenParams (void)
	Get whether we have blanks between the params or not.
ArLog::LogLevel	getProcessFileCallbacksLogLevel (void)
	Get the log level used when loading or reloading the configuration.
ArConfigArg::RestartLevel	getRestartLevelNeeded (void) const
	Gets the restart level needed.
bool	getSaveUnknown (void)
	Gets whether we save unknowns (if we don't save 'em we ignore 'em)
std::list< std::string >	getSectionNames () const
	Returns the names of all sections in the config.
std::list< std::string >	getSectionNamesInCategory (const char *categoryName) const
	Returns the names of the sections that have been added to the specified category. More...
std::list< ArConfigSection * > *	getSections (void)
	Get the sections themselves (use only if you know what to do)
virtual ArConfig *	getTranslator () const
	Returns the associated translator config, or NULL if none.
void	log (bool isSummary=true, std::list< std::string > *sectionNameList=NULL, const char *logPrefix="")
	Logs the config. More...
ArConfig &	operator= (const ArConfig &config)
	Assignment operator.
bool	parseArgument (ArArgumentBuilder *arg, char *errorBuffer=NULL, size_t errorBufferLen=0)
	This parses the argument given (for parser or other use) More...
bool	parseArgumentParser (ArArgumentParser *parser, bool continueOnError=false, char *errorBuffer=NULL, size_t errorBufferLen=0)
	Use an argument parser to change the config.
bool	parseFile (const char *fileName, bool continueOnError=false, bool noFileNotFoundMessage=false, char *errorBuffer=NULL, size_t errorBufferLen=0, std::list< std::string > *sectionsToParse=NULL, ArPriority::Priority highestPriority=ArPriority::FIRST_PRIORITY, ArPriority::Priority lowestPriority=ArPriority::LAST_PRIORITY, ArConfigArg::RestartLevel *restartLevelNeeded=NULL)
	Parse a config file. More...
bool	parseListBegin (ArArgumentBuilder *arg, char *errorBuffer, size_t errorBufferLen)
bool	parseListEnd (ArArgumentBuilder *arg, char *errorBuffer, size_t errorBufferLen)
bool	parseResourceFile (const char *fileName, bool continueOnError=true, char *errorBuffer=NULL, size_t errorBufferLen=0, std::list< std::string > *sectionsToParse=NULL)
	Parse a config resource file, for translation.
void	parseResourceFile (ArArgumentBuilder *builder)
	Parse a config resource file with parameters suitable for custom commands.
bool	parseSection (ArArgumentBuilder *arg, char *errorBuffer=NULL, size_t errorBufferLen=0)
	This parses the section change (for parser or other use) More...
bool	parseUnknown (ArArgumentBuilder *arg, char *errorBuffer=NULL, size_t errorBufferLen=0)
	This parses an unknown argument (so we can save it) More...
bool	parseVersion (ArArgumentBuilder *arg, char *errorBuffer=NULL, size_t errorBufferLen=0)
	Parses the config file version information.
virtual bool	processFile (void)
	for inheritors this is called after the file is processed More...
void	removeAllUnsetSections (void)
	Removes all values from sections in which no value has been set (internal)
void	removeAllUnsetValues (void)
	Removes all unset values from the config (internal for default configs)
void	remProcessFileCB (ArRetFunctor< bool > *functor)
	Removes a processedFile callback. More...
void	remProcessFileCB (ArRetFunctor2< bool, char *, size_t > *functor)
	Removes a processedFile callback. More...
bool	remSectionFlag (const char *sectionName, const char *flag)
	Removes a flag from a section. More...
void	remSectionNotToParse (const char *section)
	Removes a section for this config to always skip.
void	resetRestartLevelNeeded (void)
	Gets the restart level needed.
void	setBaseDirectory (const char *baseDirectory)
	Set the base directory.
virtual void	setConfigName (const char *configName, const char *robotName=NULL)
	Stores an optional config and robot name to be used in log messages. More...
void	setNoBlanksBetweenParams (bool noBlanksBetweenParams)
	Set whether we have blanks between the params or not.
void	setPermissions (bool allowFactory=true, bool rememberUnknowns=true)
	Sets permissions on some things. More...
void	setProcessFileCallbacksLogLevel (ArLog::LogLevel level)
	Set the log level used when loading or reloading the configuration.
virtual void	setQuiet (bool isQuiet)
	Turn on this flag to reduce the number of verbose log messages.
void	setSaveUnknown (bool saveUnknown)
	Sets whether we save unknown items (if we don't save 'em we ignore 'em)
void	setSectionComment (const char *sectionName, const char *comment)
	Sets the comment for a section. More...
virtual void	setTranslator (ArConfig *xlatorConfig)
	Sets an associate config that provides translations for each parameter (as read from a resource file).
void	useArgumentParser (ArArgumentParser *parser)
	Uses this argument parser after it parses a file before it processes. More...
bool	writeFile (const char *fileName, bool append=false, std::set< std::string > *alreadyWritten=NULL, bool writeExtras=false, std::list< std::string > *sectionsToWrite=NULL, ArPriority::Priority highestPriority=ArPriority::FIRST_PRIORITY, ArPriority::Priority lowestPriority=ArPriority::LAST_PRIORITY)
	Write out a config file. More...
bool	writeResourceFile (const char *fileName, bool append=false, std::set< std::string > *alreadyWritten=NULL, std::list< std::string > *sectionsToWrite=NULL)
	Write a config resource file, for translation.
void	writeResourceFile (ArArgumentBuilder *builder)
	Write a config resource file with parameters suitable for custom commands.
virtual	~ArConfig ()
	Destructor.
Public Member Functions inherited from ArHasFileName
	ArHasFileName ()
	Constructor.
	ArHasFileName (ArHasFileName const &)
	Copy constructor.
ArHasFileName &	operator= (ArHasFileName const &)
	Assignment operator.
virtual	~ArHasFileName ()
	Destructor.

Static Public Attributes
static const char *	CATEGORY_DEBUG = "Debug"
	Sections related to debug, including logging, replay, etc.
static const char *	CATEGORY_FLEET = "Enterprise"
	Sections related to the fleet, enterprise manager, etc.
static const char *	CATEGORY_ROBOT_INTERFACE = "Robot Interface"
	Sections related to I/O, ARCL, display, network communication, etc.
static const char *	CATEGORY_ROBOT_OPERATION = "Robot Operation"
	Sections related to robot behavior, docking, driving, navigation, etc.
static const char *	CATEGORY_ROBOT_PHYSICAL = "Robot Physical"
	Sections related to the robot hardware and its sensors/accessories.
static const char *	CATEGORY_SECURITY = "Security"
	Sections related to security.

Protected Member Functions
void	addListNamesToParser (const ArConfigArg &parent)
void	addParserHandlers (void)
void	copySectionsToParse (std::list< std::string > *from)
void	removeAllUnsetValues (bool isRemovingUnsetSectionsOnly)
	Removes unset values from the config. More...
void	remParserHandlers (void)
void	translateSection (ArConfigSection *section)
void	writeSection (ArConfigSection *section, FILE *file, std::set< std::string > *alreadyWritten, bool writeExtras, ArPriority::Priority highestPriority, ArPriority::Priority lowestPriority)
	Write out a section. More...
void	writeSectionResource (ArConfigSection *section, FILE *file, std::set< std::string > *alreadyWritten)
	Write out a section in CSV format for translation. More...

Protected Attributes
ArArgumentParser *	myArgumentParser
std::string	myBaseDirectory
std::map< std::string, std::list< std::string > >	myCategoryToSectionsMap
	Map that defines the section names contained in each category.
bool	myCheckingForRestartLevel
std::string	myConfigName
	Optional name of the config instance.
std::string	myConfigVersion
	Version information read from config file.
char	myCsvSeparatorChar
bool	myDuplicateParams
bool	myFailOnBadSection
std::string	myFileName
ArPriority::Priority	myHighestPriorityToParse
bool	myIgnoreBounds
bool	myIsParsingListBroken
bool	myIsQuiet
ArRetFunctor3C< bool, ArConfig, ArArgumentBuilder *, char *, size_t >	myListBeginCB
ArRetFunctor3C< bool, ArConfig, ArArgumentBuilder *, char *, size_t >	myListEndCB
std::string	myLogPrefix
	Prefix to be inserted in log messages (contains the robot and config names).
ArPriority::Priority	myLowestPriorityToParse
bool	myNoBlanksBetweenParams
ArFileParser	myParser
ArRetFunctor3C< bool, ArConfig, ArArgumentBuilder *, char *, size_t >	myParserCB
std::list< std::string >	myParsingListNames
bool	myPermissionAllowFactory
bool	myPermissionSaveUnknown
ArLog::LogLevel	myProcessFileCallbacksLogLevel
std::multimap< int, ProcessFileCBType * >	myProcessFileCBList
ArConfigArg::RestartLevel	myRestartLevelNeeded
std::string	myRobotName
	Optional name of the robot with which the config is associated.
bool	mySaveUnknown
std::string	mySection
bool	mySectionBroken
ArRetFunctor3C< bool, ArConfig, ArArgumentBuilder *, char *, size_t >	mySectionCB
bool	mySectionIgnored
std::list< ArConfigSection * >	mySections
std::set< std::string >	mySectionsNotToParse
std::list< std::string > *	mySectionsToParse
ArConfig *	myTranslator
ArRetFunctor3C< bool, ArConfig, ArArgumentBuilder *, char *, size_t >	myUnknownCB
bool	myUsingSections
ArRetFunctor3C< bool, ArConfig, ArArgumentBuilder *, char *, size_t >	myVersionCB

Detailed Description

Stores configuration information which may be read to and from files or other sources.

The configuration is a set of parameters (or config arguments), organized into sections. Parameters contain a key or name (a short string), a value (which may be one of several types), a priority (important, normal, or trivial to most users), a longer description, and a display hint which suggests what kind of UI control might be most appropriate for the parameter. After adding a parameter to the configuration, its value may be changed when the configuration is loaded or reloaded from a file. Various program modules may register callbacks to be notified when a shared global configuration (such as the static ArConfig object kept by the Aria class) is loaded or otherwise changed.

Classes dealing with more specialized kinds of config files inherit from this one.

Important methods in this class are: addParam(), addProcessFileCB(), remProcessFileCB(), parseFile(), writeFile().

Usually, configuration data are read from and written to a file using parseFile() and writeFile(), or are set by a remote client via ArNetworking. It is also possible to import configuration settings from an ArArgumentParser (which, for example, may contain a program's command line arguments) using useArgumentParser().

Warning

ArConfig does not escape any special characters when writing or loading to/from a file. Therefore in general parameter names, values, section names, and comments must not contain characters which have special meaning in a config file, such as '#', ';', tab or newline. (see also ArFileParser) Parameter names may have spaces, though by convention they generally do not.

Examples:

configExample.cpp.

Constructor & Destructor Documentation

ArConfig()

ArConfig::ArConfig	(	const char *	baseDirectory = NULL,
		bool	noBlanksBetweenParams = false,
		bool	ignoreBounds = false,
		bool	failOnBadSection = false,
		bool	saveUnknown = true
	)

Constructor.

Parameters

baseDirectory	a directory to search for files in
noBlanksBetweenParams	if there should not be blank lines between params in output
ignoreBounds	if this is true bounds checking will be ignored when the file is read in. this should ONLY be used by developers debugging
failOnBadSection	if this is true and there is a bad section, then parseFile will fail
saveUnknown	if this is true and there are unknown parameters or sections then they will be saved, if false then they will be ignored (can also be set with setSaveUnknown())

Member Function Documentation

addComment()

bool ArConfig::addComment	(	const char *	comment,
		const char *	sectionName = "",
		ArPriority::Priority	priority = ArPriority::NORMAL
	)

Command to add a new comment to the given section with given priority.

Add a comment to a section.

Parameters

comment	Text of the comment.
sectionName	Name of the section to add the comment to. If the section does not exist, it will be created.
priority	Priority or importance.

Warning

The section name must not contain any characters with special meaning when saved and loaded from a config file, such as '#', ';', tab, or newline. The comment must not contain tab or newline, but '#' and ';' are OK within a comment.

addParam()

bool ArConfig::addParam	(	const ArConfigArg &	arg,
		const char *	sectionName = "",
		ArPriority::Priority	priority = ArPriority::NORMAL,
		const char *	displayHint = NULL,
		ArConfigArg::RestartLevel	restart = ArConfigArg::NO_RESTART
	)

Command to add a parameter to the given section with given priority.

Add a parameter.

Parameters

arg	Object containing key, description and value type of this parameter. This object will be copied.
sectionName	Name of the section to put this parameter in.
priority	Priority or importance of this parameter to a user.
displayHint	Suggest an appropriate UI control for editing this parameter's value. See ArConfigArg::setDisplayHint() for description of display hint format.
restart	restart level

Warning

The parameter name and value must not contain any characters with special meaning when saved and loaded from a config file, such as '#', ';', tab, or newline.

Examples:

configExample.cpp.

addParamAsIs()

bool ArConfig::addParamAsIs	(	const ArConfigArg &	arg,
		const char *	sectionName = ""
	)

Adds a parameter that has all the other information on it already set.

Add a parameter.

Parameters

arg	Object containing key, description and value type of this parameter. This object will be copied.... it must already have the priority, display hint, restart level, and other things like that already set.
sectionName	Name of the section to put this parameter in.

addProcessFileCB() [1/2]

void ArConfig::addProcessFileCB	(	ArRetFunctor< bool > *	functor,
		int	priority = 0
	)

Adds a callback to be invoked when the configuration is loaded or reloaded.

After a file has been read all the way these processFileCBs are called in the priority (higher numbers first)...

these are only called if there were no errors parsing the file or continueOnError was set to false when parseFile was called

The functor should return true if the config parsed was good (parseFile will return true) false if the config parsed wasn't (parseFile will return false)

Parameters

functor	the functor to call
priority	the functors are called in descending order, if two things have the same number the first one added is the first one called

Examples:

configExample.cpp.

addProcessFileCB() [2/2]

void ArConfig::addProcessFileCB	(	ArRetFunctor2< bool, char *, size_t > *	functor,
		int	priority = 0
	)

Adds a callback to be invoked when the configuration is loaded or reloaded....

After a file has been read all the way these processFileCBs are called in the priority (higher numbers first)...

if you really want errors you should use addProcessFileWithErrorCB, this is just to catch mistakes

these are only called if there were no errors parsing the file or continueOnError was set to false when parseFile was called

The functor should return true if the config parsed was good (parseFile will return true) false if the config parsed wasn't (parseFile will return false)

Parameters

functor	the functor to call
priority	the functors are called in descending order, if two things have the same number the first one added is the first one called

addProcessFileWithErrorCB()

void ArConfig::addProcessFileWithErrorCB	(	ArRetFunctor2< bool, char *, size_t > *	functor,
		int	priority = 0
	)

Adds a callback to be invoked when the configuration is loaded or reloaded, which may also receive error messages.

This function has a different name than addProcessFileCB just so that if you mean to get this function but have the wrong functor you'll get an error.

The rem's are the same though since that shouldn't matter.

After a file has been read all the way these processFileCBs are called in the priority (higher numbers first)... these are only called if there were no errors parsing the file or continueOnError was set to false when parseFile was called

The functor should return true if the config parsed was good (parseFile will return true) false if the config parsed wasn't (parseFile will return false)

Parameters

functor	the functor to call (the char * and unsigned int should be used by the functor to put an error message into that buffer)
priority	the functors are called in descending order, if two things have the same number the first one added is the first one called

addSection()

bool ArConfig::addSection	(	const char *	categoryName,
		const char *	sectionName,
		const char *	sectionDescription
	)

Command to add a section and its description to the specified category.

The category is expected to be one of the CATEGORY_ constants defined above.

addSectionFlags()

bool ArConfig::addSectionFlags	(	const char *	sectionName,
		const char *	flags
	)

adds a flag to a section

Add a flag to a section.

If the section doesn't exist then it is created.

Warning

The section name and flags must not contain any characters with special meaning when saved and loaded from a config file, such as '#', ';', tab, or newline.

findSection()

ArConfigSection * ArConfig::findSection

(

const char *

sectionName

)

const

Find the section with the given name.

Returns

section object, or NULL if not found.

Examples:

configExample.cpp.

getSectionNamesInCategory()

std::list< std::string > ArConfig::getSectionNamesInCategory

(

const char *

categoryName

)

const

Returns the names of the sections that have been added to the specified category.

Parameters

categoryName

the char * name of the category for which to find the section names; if empty/null, then the method returns the names of all sections that have not been included in any category

log()

void ArConfig::log	(	bool	isSummary = true,
		std::list< std::string > *	sectionNameList = NULL,
		const char *	logPrefix = ""
	)

Logs the config.

Parameters

isSummary	a bool set to true if only the section names and parameter counts should be logged; false to log detailed parameter information
sectionNameList	a list of the string section names to be logged; if NULL, then the data for all sections are logged

parseArgument()

bool ArConfig::parseArgument	(	ArArgumentBuilder *	arg,
		char *	errorBuffer = NULL,
		size_t	errorBufferLen = 0
	)

This parses the argument given (for parser or other use)

The extra string of the parser should be set to the command wanted, while the rest of the arg should be the arguments to the command.

Its case insensitive.

Parameters

arg	Obtain parameter name from this object's "extra string" and value(s) from its argument(s).
errorBuffer	If this is NULL it is ignored, otherwise the string for the error is put into the buffer, the first word should be the parameter that has trouble
errorBufferLen	the length of errorBuffer

MPL we'll want to do something here, but kathleen and i still have to work out what...

parseFile()

bool ArConfig::parseFile	(	const char *	fileName,
		bool	continueOnErrors = false,
		bool	noFileNotFoundMessage = false,
		char *	errorBuffer = NULL,
		size_t	errorBufferLen = 0,
		std::list< std::string > *	sectionsToParse = NULL,
		ArPriority::Priority	highestPriority = ArPriority::FIRST_PRIORITY,
		ArPriority::Priority	lowestPriority = ArPriority::LAST_PRIORITY,
		ArConfigArg::RestartLevel *	restartLevelNeeded = NULL
	)

Parse a config file.

Parameters

fileName	the file to load
continueOnErrors	whether to continue parsing if we get errors (or just bail)
noFileNotFoundMessage	if the file isn't found and this param is true it won't complain, otherwise it will
errorBuffer	If an error occurs and this is not NULL, copy a description of the error into this buffer
errorBufferLen	the length of errorBuffer
sectionsToParse	if NULL, then parse all sections; otherwise, a list of the section names that should be parsed (sections not in the list are ignored)
highestPriority	Any configuration settings with a priority before this are ignored
lowestPriority	Any configuration settings with a priority after this are ignored. @param restartLevelNeeded for internal use, leave as NULL

Examples:

configExample.cpp.

parseSection()

bool ArConfig::parseSection	(	ArArgumentBuilder *	arg,
		char *	errorBuffer = NULL,
		size_t	errorBufferLen = 0
	)

This parses the section change (for parser or other use)

The extra string of the parser should be set to the 'Section' command while the rest of the arg should be the arguments to the section command.

Its case insensitive.

Parameters

arg	Should contain the 'Section' keyword as its "extra" string, and section name as argument(s).
errorBuffer	if this is NULL it is ignored, otherwise the string for the error is put into the buffer, the first word should be the parameter that has trouble
errorBufferLen	the length of the error buffer

parseUnknown()

bool ArConfig::parseUnknown	(	ArArgumentBuilder *	arg,
		char *	errorBuffer = NULL,
		size_t	errorBufferLen = 0
	)

This parses an unknown argument (so we can save it)

The extra string of the parser should be set to the command wanted, while the rest of the arg should be the arguments to the command.

Its case insensitive.

Parameters

arg	Obtain parameter name from this argument builder's "exra" string and value(s) from its argument(s).
errorBuffer	if this is NULL it is ignored, otherwise the string for the error is put into the buffer, the first word should be the parameter that has trouble
errorBufferLen	the length of the error buffer

processFile()

virtual bool ArConfig::processFile ( void  )

inlinevirtual

for inheritors this is called after the file is processed

For classes that inherit from ArConfig this function is called after parseFile and all of the processFileCBs are called... If you want to call something before the processFileCBs then just add a processFileCB... this is only called if there were no errors parsing the file or continueOnError was set to false when parseFile was called

Returns

true if the config parsed was good (parseFile will return true) false if the config parsed wasn't (parseFile will return false)

removeAllUnsetValues()

void ArConfig::removeAllUnsetValues ( bool  isRemovingUnsetSectionsOnly )

protected

Removes unset values from the config.

Parameters

isRemovingUnsetSectionsOnly

a bool set to true if unset parameters should not be removed from sections that have any set parameters; false if all unset values should be removed

remProcessFileCB() [1/2]

void ArConfig::remProcessFileCB

(

ArRetFunctor< bool > *

functor

)

Removes a processedFile callback.

Removes a processFileCB, see addProcessFileCB for details.

remProcessFileCB() [2/2]

void ArConfig::remProcessFileCB

(

ArRetFunctor2< bool, char *, size_t > *

functor

)

Removes a processedFile callback.

Removes a processFileCB, see addProcessFileCB for details.

remSectionFlag()

bool ArConfig::remSectionFlag	(	const char *	sectionName,
		const char *	flag
	)

Removes a flag from a section.

Add a flag to a section.

If the section doesn't exist then it is created.

setConfigName()

void ArConfig::setConfigName ( const char *  configName, const char *  robotName = NULL  )

virtual

Stores an optional config and robot name to be used in log messages.

These names are used solely for log messages.

Parameters

configName	a char * descriptive name of the ArConfig instance (e.g. Server or Default)
robotName	an optional char * identifier of the robot that has the config

setPermissions()

void ArConfig::setPermissions	(	bool	allowFactory = true,
		bool	rememberUnknowns = true
	)

Sets permissions on some things.

This is more temporary than some of the others like 'setSaveUknown' and such, this should be called by anything that's going to parse the config...

setSectionComment()

void ArConfig::setSectionComment	(	const char *	sectionName,
		const char *	comment
	)

Sets the comment for a section.

Set the comment string associated with a section.

If the section doesn't exist then it is created.

Deprecated:

use addSection instead

Warning

The section name must not contain any characters with special meaning when saved and loaded from a config file, such as '#', ';', tab, or newline. The comment must not contain tab or newline, but '#' and ';' are OK within a comment.

Examples:

configExample.cpp.

useArgumentParser()

void ArConfig::useArgumentParser

(

ArArgumentParser *

parser

)

Uses this argument parser after it parses a file before it processes.

This argument parser the arguments in to check for parameters of this name, note that ONLY the first parameter of this name will be used, so if you have duplicates only the first one will be set.

writeFile()

bool ArConfig::writeFile	(	const char *	fileName,
		bool	append = false,
		std::set< std::string > *	alreadyWritten = NULL,
		bool	writeExtras = false,
		std::list< std::string > *	sectionsToWrite = NULL,
		ArPriority::Priority	highestPriority = ArPriority::FIRST_PRIORITY,
		ArPriority::Priority	lowestPriority = ArPriority::LAST_PRIORITY
	)

Write out a config file.

Parameters

fileName	the name of the file to write out
append	if true then text will be appended to the file if it exists, otherwise any existing file will be overwritten.
alreadyWritten	if non-NULL, a list of strings that have already been written out, don't write it again if it's in this list; when something is written by this function, then it is put it into this list
writeExtras	if this is true then the priority, display hint, restart level, and other later extras of each parameter will also be written to the file, if it is false they will not be
sectionsToWrite	if NULL, then write all sections; otherwise, a list of the section names that should be written
highestPriority	the ArPriority::Priority that specifies the minimum (numerical) priority that a parameter must have in order to be written; not related to the writeExtras flag
lowestPriority	the ArPriority::Priority that specifies the maximum (numerical) priority that a parameter must have in order to be written; not related to the writeExtras flag

Examples:

configExample.cpp.

writeSection()

void ArConfig::writeSection ( ArConfigSection *  section, FILE *  file, std::set< std::string > *  alreadyWritten, bool  writeExtras, ArPriority::Priority  highestPriority, ArPriority::Priority  lowestPriority  )

protected

Write out a section.

clear out our written ones between sections

writeSectionResource()

void ArConfig::writeSectionResource ( ArConfigSection *  section, FILE *  file, std::set< std::string > *  alreadyWritten  )

protected

Write out a section in CSV format for translation.

clear out our written ones between sections

---

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

• ArConfig.h
• ArConfig.cpp