An instance of this class represents the Databases section of mascot.dat. More...

#include <ms_databaseoptions.hpp>

Inheritance diagram for ms_databases:

Collaboration diagram for ms_databases:

Public Member Functions
	ms_databases ()
	Default constructor.

	ms_databases (const ms_databases &src)
	Copying constructor.

	~ms_databases ()
	Destructor.

void	appendDatabase (const ms_databaseoptions *item)
	Add one more database definition at the end of the list.

void	appendProperty (const char name, const char value, const char *delimiter, const bool bFirstPlace=false)
	Adds a new property with the given parameters.

void	appendText (const char *line, const bool bFirstPlace=false)
	Adds a new non-parsed property.

void	clearDatabases ()
	Deletes all database definitions.

void	copyFrom (const ms_customproperty *src)
	Copies all properties and comments from another instance.

void	copyFrom (const ms_databases *right)
	Can be used to create a copy of another object.

void	defaultValues ()
	Initialises the instance with default values.

bool	deleteDatabaseByName (const char *name)
	Remove a database from the list in memory.

bool	deleteDatabaseByNumber (const int num)
	Remove a database from the list in memory.

void	delNonEmpty ()
	Deletes all non-comment properties.

void	delProp (const char *name)
	Deletes all properties with the specified name.

void	delPropByNumber (const int index)
	Deletes a single property with the specified number only.

void	delPropStart (const char *nameBeginning)
	Deletes all properties whose names start with the given string.

int	findDatabase (const char *dbName, const bool searchInactive=false) const
	Finds a database with the specified name and returns its number to access.

int	findProperty (const char *name, const int startFrom=0) const
	Searches the list for a property with the given name.

int	findPropertyBeginning (const char *nameBeginning, const int startFrom=0) const
	Searches the list for a property with the partially matching name.

const ms_databaseoptions *	getDatabase (const int index) const
	Returns a database definition by its number.

std::string	getDefaultDelimiter () const
	Return current default delimiter string used for parsing/storing properties.

std::string	getDelimiterByNumber (const int index) const
	Returns a specific delimiter used for the property.

int	getNumberOfDatabases () const
	Returns the total number of database definitions including inactive (commented out) databases.

int	getNumberOfProperties () const
	Returns a total number of property/comment entries.

std::string	getPreceedingComments () const
	Returns any comments preceeding the section.

std::string	getPropertyName (const int index) const
	Returns a property name for a given index.

std::string	getPropValStringByName (const char *name) const
	Retrieves property value by name.

std::string	getPropValStringByNumber (const int index) const
	Retrieves property raw text values by number.

bool	isSectionAvailable () const
	Check if the section has been actually read form the file or have to be saved.

ms_databases &	operator= (const ms_databases &right)
	Assignment operator for C++ client applications.

void	setDefaultDelimiter (const char *delim)
	Allows to set a specific delimiter string to be used when no property-specific delimiter is supplied.

void	setPreceedingComments (const std::string &comments)
	Sets any comments preceeding the section.

void	setPropertyName (const int index, const char *name)
	Changes name of the property with the given index.

void	setPropValBoolByName (const char *name, const bool value, const bool bFirstPlace=false)
	Changes a boolean value of the first entry with the given name or creates a new property if it is not found.

void	setPropValCharByName (const char *name, const char value, const bool bFirstPlace=false)
	Changes a single character value of the first entry with the given name or creates a new property if it is not found.

void	setPropValFloatByName (const char *name, const double value, const bool bFirstPlace=false)
	Changes an floating point value of the first entry with the given name or creates a new property if it is not found.

void	setPropValInt64ByName (const char *name, const INT64 value, const bool bFirstPlace=false)
	Changes a long 64-bit integer value of the first entry with the given name or creates a new property if it is not found.

void	setPropValIntByName (const char *name, const int value, const bool bFirstPlace=false)
	Changes an integer value of the first entry with the given name or creates a new property if it is not found.

void	setPropValStringByName (const char name, const char value, const bool bFirstPlace=false)
	Changes a string value of the first entry with the given name or creates a new property if it is not found.

void	setPropValStringByNumber (const int index, const char *value)
	Changes an string value of an existing property with the given index.

void	setSectionAvailable (const bool value)
	Changes availability of the section, i.e. whether it should be saved in the file.

bool	uncommentProp (const int index, const char *delimeter=0)
	Uncomments a line in the configuration file.

bool	updateDatabaseByName (const char *name, const ms_databaseoptions db)
	Update the information for a specific database.

bool	updateDatabaseByNumber (const int num, const ms_databaseoptions db)
	Update the information for a specific database.

Detailed Description

An instance of this class represents the Databases section of mascot.dat.

An instance is created and populated with database entries within ms_datfile class. It contains active database definitions as well as inactive ones. When traversing the list of database with getNumberOfDatabases() and getDatabase() members, don't forget to check each entry for being active. Otherwise one or all database parameters might be invalid and, therefore, must be ignored. In a text-based configuration file a database definition can be made inactive by commenting it out.

For detailed information on any of the options please consult Mascot manual.

Also get yourselves acquainted with the base class ms_customproperty. It facilitates the following tasks:

retrieving an unsupported property
retrieving raw/text/xml property representation
checking for existence of a certain property rather than dealing with its default value
accessing commented lines in a section

More functionality is described in details in the documentation for the class.

Examples: config_mascotdat.cpp.

Member Function Documentation

◆ appendDatabase()

void appendDatabase ( const ms_databaseoptions * item )

Add one more database definition at the end of the list.

Parameters

item	valid pointer to a ms_databaseoptions object

◆ appendProperty()

void appendProperty	(	const char *	name,
		const char *	value,
		const char *	delimiter,
		const bool	bFirstPlace = `false`
	)

inherited

Adds a new property with the given parameters.

Parameters

name	a property name to use.
value	a property value to use.
delimiter	a specific delimiter or an empty string for a default one to be used.
bFirstPlace	forces a new property to be put on top of the list.

◆ appendText()

void appendText	(	const char *	l,
		const bool	bFirstPlace = `false`
	)

inherited

Adds a new non-parsed property.

All property elements will be retrieved from the first parameter. Before calling this method, a specific default delimiter can be set using setDefaultDelimiter().

Parameters

l	raw text representation of the property to be parsed.
bFirstPlace	forces a new property to be put on top of the list.

◆ deleteDatabaseByName()

bool deleteDatabaseByName ( const char * name )

Remove a database from the list in memory.

If the database name is specified incorrectly FALSE value is returned and no action is performed.

Parameters

name	the database name.

Returns: TRUE if the database has been found and deleted and FALSE otherwise.

◆ deleteDatabaseByNumber()

bool deleteDatabaseByNumber ( const int num )

Remove a database from the list in memory.

If the database index is specified incorrectly FALSE value is returned and no action is performed.

Parameters

num	zero-based database index.

Returns: TRUE if the database has been deleted and FALSE otherwise.

◆ delProp()

void delProp ( const char * str )

inherited

Deletes all properties with the specified name.

Parameters

str	Property name to find a match and then delete.

◆ delPropStart()

void delPropStart ( const char * str )

inherited

Deletes all properties whose names start with the given string.

Parameters

str	Beginning a first part of the property name to delete.

◆ findDatabase()

int findDatabase	(	const char *	dbName,
		const bool	searchInactive = `false`
	)		const

Finds a database with the specified name and returns its number to access.

Note that only active database will be returned (unless searchInactive is set to TRUE). If no database have been found the returning value will be -1.

Parameters

dbName	a database name to find.
searchInactive	set this parameter to TRUE if you want to search both active and inactive databases.

Returns: the database index if found and -1 if not.

◆ findProperty()

int findProperty	(	const char *	name,
		const int	startFrom = `0`
	)		const

inherited

Searches the list for a property with the given name.

If no property found with the given name -1 will be returned. There may be several property entries in the list with the same name.

Parameters

name	a property name to be found.
startFrom	a minimal property index to start search from.

Returns: a property index or -1 if no property found.

◆ findPropertyBeginning()

int findPropertyBeginning	(	const char *	nameBeginning,
		const int	startFrom = `0`
	)		const

inherited

Searches the list for a property with the partially matching name.

If no property found with the given name part -1 will be returned. There may be several property entries in the list whose names start with the given string.

Parameters

nameBeginning	first part of a property name to be found.
startFrom	a minimal property index to start search from.

Returns: a property index or -1 if no property found.

◆ getDatabase()

const ms_databaseoptions * getDatabase ( const int index ) const

Returns a database definition by its number.

Use this member to retrieve a database definition with index from 0 to (getNumberOfDatabases()-1).

Parameters

index number of database to look for

Returns: pointer to a ms_databaseoptions object

Examples: config_mascotdat.cpp.

◆ getDefaultDelimiter()

std::string getDefaultDelimiter ( ) const

inherited

Return current default delimiter string used for parsing/storing properties.

Returns: default delimiter

◆ getDelimiterByNumber()

std::string getDelimiterByNumber ( const int index ) const

inherited

Returns a specific delimiter used for the property.

Parameters

index Index for which to get a delimiter

Returns: corresponding delimiter

◆ getNumberOfDatabases()

int getNumberOfDatabases ( ) const

Returns the total number of database definitions including inactive (commented out) databases.

By default the list of database is empty unless explicitly populated.

Returns: Number of databases

Examples: config_mascotdat.cpp.

◆ getNumberOfProperties()

int getNumberOfProperties ( ) const

inherited

Returns a total number of property/comment entries.

Returns: Number of property/comment entries

◆ getPreceedingComments()

std::string getPreceedingComments ( ) const

inherited

Returns any comments preceeding the section.

Sections in the mascot.dat file may have comments preceeding them. In most cases, these comments need to stay 'attached' to the section.

Multiple line comments are supported by having a single string with newline characters

See also: setPreceedingComments()

Returns: any comments preceeding the section

◆ getPropertyName()

std::string getPropertyName ( const int index ) const

inherited

Returns a property name for a given index.

Parameters

index property number from 0 to (getNumberOfProperties()-1).

Returns: Rroperty name of an empty string for comments.

◆ getPropValStringByName()

std::string getPropValStringByName ( const char * name ) const

inherited

Retrieves property value by name.

Don't use this method for comments as they all have empty name. Also note that there might be several entries corresponding to the same name . – only the first value will be returned. If in doubt use findProperty() and getPropValStringByNumber() instead.

Parameters

name	Name for which to get a property value

Returns: corresponding property value

◆ getPropValStringByNumber()

std::string getPropValStringByNumber ( const int index ) const

inherited

Retrieves property raw text values by number.

Parameters

index Index for which to get a property value

Returns: corresponding property value

◆ setDefaultDelimiter()

void setDefaultDelimiter ( const char * delim )

inherited

Allows to set a specific delimiter string to be used when no property-specific delimiter is supplied.

Parameters

delim String to set the default delimiter

◆ setPreceedingComments()

void setPreceedingComments ( const std::string & comments )

inherited

Sets any comments preceeding the section.

Sections in the mascot.dat file may have comments preceeding them. In most cases, these comments need to stay 'attached' to the section.

Multiple line comments are supported by having a single string with newline characters

See also: getPreceedingComments()

Parameters

comments any comments preceeding the section

◆ setPropertyName()

void setPropertyName	(	const int	index,
		const char *	name
	)

inherited

Changes name of the property with the given index.

Parameters

index	property number from 0 to (getNumberOfProperties()-1).
name	new name to be given to the property.

◆ setPropValBoolByName()

void setPropValBoolByName	(	const char *	name,
		const bool	value,
		const bool	bFirstPlace = `false`
	)

inherited

Changes a boolean value of the first entry with the given name or creates a new property if it is not found.

A new value will be converted into 1 (for TRUE) or 0 (for FALSE) character.

Parameters

name	a name of the property to find or add.
value	a new boolean value for the property.
bFirstPlace	if not found a new property can be put on top of the list.

◆ setPropValCharByName()

void setPropValCharByName	(	const char *	name,
		const char	value,
		const bool	bFirstPlace = `false`
	)

inherited

Changes a single character value of the first entry with the given name or creates a new property if it is not found.

Parameters

name	a name of the property to find or add.
value	a new single character value for the property.
bFirstPlace	if not found a new property can be put on top of the list.

◆ setPropValFloatByName()

void setPropValFloatByName	(	const char *	name,
		const double	value,
		const bool	bFirstPlace = `false`
	)

inherited

Changes an floating point value of the first entry with the given name or creates a new property if it is not found.

Parameters

name	a name of the property to find or add.
value	a new floating point value for the property.
bFirstPlace	if not found a new property can be put on top of the list.

◆ setPropValInt64ByName()

void setPropValInt64ByName	(	const char *	name,
		const INT64	value,
		const bool	bFirstPlace = `false`
	)

inherited

Changes a long 64-bit integer value of the first entry with the given name or creates a new property if it is not found.

Parameters

name	a name of the property to find or add.
value	a new long 64-bit integer value for the property.
bFirstPlace	if not found a new property can be put on top of the list.

◆ setPropValIntByName()

void setPropValIntByName	(	const char *	name,
		const int	value,
		const bool	bFirstPlace = `false`
	)

inherited

Changes an integer value of the first entry with the given name or creates a new property if it is not found.

Parameters

name	a name of the property to find or add.
value	a new integer value for the property.
bFirstPlace	if not found a new property can be put on top of the list.

◆ setPropValStringByName()

void setPropValStringByName	(	const char *	name,
		const char *	value,
		const bool	bFirstPlace = `false`
	)

inherited

Changes a string value of the first entry with the given name or creates a new property if it is not found.

Parameters

name	a name of the property to find or add.
value	a new string value for the property.
bFirstPlace	if not found a new property can be put on top of the list.

◆ setPropValStringByNumber()

void setPropValStringByNumber	(	const int	index,
		const char *	str
	)

inherited

Changes an string value of an existing property with the given index.

Parameters

index	an index of an existing property.
str	String value for the property.

◆ uncommentProp()

bool uncommentProp	(	const int	index,
		const char *	delimeter = `0`
	)

inherited

Uncomments a line in the configuration file.

Removes a # and any white space. Finds the delimeter and extracts the property name and value.

Parameters

index	must be a value between 0 and getNumberOfProperties().
delimeter	will often be a space. If not supplied, the default delimeter will be used.

Returns: true if the delimiter was found, false otherwise

◆ updateDatabaseByName()

bool updateDatabaseByName	(	const char *	name,
		const ms_databaseoptions	db
	)

Update the information for a specific database.

If a database with the supplied name cannot be found no database will be updated and the returning value will be FALSE.

Parameters

name	a database name to find.
db	a database object to copy the content from.

Returns: TRUE if the database has been successfully found and updated and FALSE otherwise.

◆ updateDatabaseByNumber()

bool updateDatabaseByNumber	(	const int	num,
		const ms_databaseoptions	db
	)

Update the information for a specific database.

If the index is out of bounds no database will be updated and the returning value will be FALSE.

Parameters

num	a zero-based index of the database to update.
db	a database object to copy the content from.

Returns: TRUE if the database index indicates a valid database in the internal list and FALSE otherwise.

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

ms_databaseoptions.hpp
ms_databaseoptions.cpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ appendDatabase()

◆ appendProperty()

◆ appendText()

◆ deleteDatabaseByName()

◆ deleteDatabaseByNumber()

◆ delProp()

◆ delPropStart()

◆ findDatabase()

◆ findProperty()

◆ findPropertyBeginning()

◆ getDatabase()

◆ getDefaultDelimiter()

◆ getDelimiterByNumber()

◆ getNumberOfDatabases()

◆ getNumberOfProperties()

◆ getPreceedingComments()

◆ getPropertyName()

◆ getPropValStringByName()

◆ getPropValStringByNumber()

◆ setDefaultDelimiter()

◆ setPreceedingComments()

◆ setPropertyName()

◆ setPropValBoolByName()

◆ setPropValCharByName()

◆ setPropValFloatByName()

◆ setPropValInt64ByName()

◆ setPropValIntByName()

◆ setPropValStringByName()

◆ setPropValStringByNumber()

◆ uncommentProp()

◆ updateDatabaseByName()

◆ updateDatabaseByNumber()