CGlobalVariableSet Class Reference

Manages a set of global compiler variables. More...

#include <cbglobalvar.h>

Public Member Functions
CString &	Name (void)
	Name of the set. More...
bool &	Active (void)
	Indicates that this variable set should be defined in makefile. More...
void	Clear (void)
	Resets the set of variables to the initial state. More...
size_t	Count (void) const
	Returns number of variables. More...
CGlobalVariable *	Get (const size_t Index)
	Returns a variable by index. More...
CGlobalVariable *	Find (const CString &Name)
	Returns a variable by name. More...
CGlobalVariable *	Add (const CString &Name, const CString &Description="")
	Adds new variable with name Name and description Description. More...
void	Remove (const CString &Name)
	Removes variable with name Name. More...
void	Read (const TiXmlElement *GlobalVariableSetRoot)
	Reads the global variable set settings from an XML document. More...
void	Write (TiXmlElement *GlobalVariableSetRoot)
	Writes the global variable set settings to an XML document. More...
void	Show (void)
	Prints the global compiler variable set contents to standard output. More...
	CGlobalVariableSet (void)
	Creates global compiler variable set. More...
	~CGlobalVariableSet (void)
	Destroys global compiler variable set. More...

Private Attributes
CString	m_Name
	Name of the variable set. More...
std::vector< CGlobalVariable * >	m_Variables
	List of global compiler variables. More...
bool	m_Active
	Indicates that this variable set should be defined in makefile. More...

Detailed Description

Manages a set of global compiler variables.

Constructor & Destructor Documentation

CGlobalVariableSet::CGlobalVariableSet

(

void

)

Creates global compiler variable set.

CGlobalVariableSet::~CGlobalVariableSet

(

void

)

Destroys global compiler variable set.

Member Function Documentation

CGlobalVariableSet::Active ( void  )

inline

Indicates that this variable set should be defined in makefile.

Returns

CGlobalVariableSet::m_Active.

CGlobalVariableSet::Add	(	const CString &	Name,
		const CString &	Description = ""
	)

Adds new variable with name Name and description Description.

Parameters

Name	name of the variable.
Description	description of the variable (optional).

Returns

pointer to global compiler variable.

If a variable with name Name already exists, new variable will not be created.

CGlobalVariableSet::Clear

(

void

)

Resets the set of variables to the initial state.

CGlobalVariableSet::Count ( void  ) const

inline

Returns number of variables.

Returns

number of variables.

CGlobalVariableSet::Find

(

const CString &

Name)

Returns a variable by name.

Parameters

Name	name of a variable.

Returns

pointer to the variable or NULL if variable with index Index does not exist.

CGlobalVariableSet::Get

(

const size_t

Index)

Returns a variable by index.

Parameters

Index

index of a variable.

Returns

pointer to a variable or NULL if a variable with index Index does not exist.

CGlobalVariableSet::Name ( void  )

inline

Name of the set.

Returns

reference to CGlobalVariableSet::m_Name.

CGlobalVariableSet::Read

(

const TiXmlElement *

GlobalVariableSetRoot)

Reads the global variable set settings from an XML document.

Parameters

GlobalVariableSetRoot

an element of XML document.

CGlobalVariableSet::Remove

(

const CString &

Name)

Removes variable with name Name.

Parameters

Name	name of a variable.

CGlobalVariableSet::Show

(

void

)

Prints the global compiler variable set contents to standard output.

CGlobalVariableSet::Write

(

TiXmlElement *

GlobalVariableSetRoot)

Writes the global variable set settings to an XML document.

Parameters

GlobalVariableSetRoot

an element of XML document.

Member Data Documentation

CGlobalVariableSet::m_Active

private

Indicates that this variable set should be defined in makefile.

CGlobalVariableSet::m_Name

private

Name of the variable set.

CGlobalVariableSet::m_Variables

private

List of global compiler variables.

---

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

• src/cbglobalvar.h
• src/cbglobalvar.cpp
• src/doc/cbglobalvar.dox