paceval_cListOfVariables Class Reference

The class paceval_cListOfVariables is derived from paceval_cRegisteredObject and encapsulates the storage of a list of user variable identifiers (e.g. "x", "y", "z" or "variable_01", "variable_02" ... etc.). More...

#include "inc/paceval_cListOfVariables.h"

Inheritance diagram for paceval_cListOfVariables:

Collaboration diagram for paceval_cListOfVariables:

Public Member Functions
	paceval_cListOfVariables (paceval_cCleanupHandler *handle_CleanupHandler_in)
void	initializeData (unsigned long proposedSize_in)
	~paceval_cListOfVariables ()
bool	doAddVariable (const char *varable_in)
void	addVariablesAtOnce (const char *variables_in, unsigned long numberOfVariables_in)
unsigned long	getNumberOfVariables ()
long	identifyVariablePositionfromString (const char *variable_in)
Public Member Functions inherited from paceval_cRegisteredObject
	paceval_cRegisteredObject (paceval_cCleanupHandler *handle_CleanupHandler_in)
	~paceval_cRegisteredObject ()
void	setRegisterPosition (unsigned long registerPosition_in)
unsigned long	getRegisterPosition ()

Private Member Functions
const char *	getVariable (unsigned long position_in)

Private Attributes
paceval_cListOfPointer *	listOfPointers

Additional Inherited Members
Protected Attributes inherited from paceval_cRegisteredObject
paceval_cCleanupHandler *	handle_CleanupHandler
unsigned long	registerPosition

Detailed Description

The class paceval_cListOfVariables is derived from paceval_cRegisteredObject and encapsulates the storage of a list of user variable identifiers (e.g. "x", "y", "z" or "variable_01", "variable_02" ... etc.).

Constructor & Destructor Documentation

paceval_cListOfVariables()

paceval_cListOfVariables::paceval_cListOfVariables

(

paceval_cCleanupHandler *

handle_CleanupHandler_in

)

the constructor of paceval_cListOfVariables

Parameters

handle_CleanupHandler_in

is the associated handler for deleting this registered object

~paceval_cListOfVariables()

paceval_cListOfVariables::~paceval_cListOfVariables

(

)

the destructor of paceval_cListOfVariables

Here is the call graph for this function:

Member Function Documentation

addVariablesAtOnce()

void paceval_cListOfVariables::addVariablesAtOnce	(	const char *	variables_in,
		unsigned long	numberOfVariables_in )

adds variable identifiers separated by blanks to the list in one step (annotation: if the variable identifiers all have a length of 1, the blank can be omitted)

Parameters

variables_in	specifies the string of the variable identifiers separated by blanks
numberOfVariables_in	specifies the number of variable identifiers

Here is the call graph for this function:

Here is the caller graph for this function:

doAddVariable()

bool paceval_cListOfVariables::doAddVariable

(

const char *

varable_in

)

adds a variable identifier to the list and returns whether this was successful (true) or not (false)

Parameters

varable_in

specifies the string of the variable identifier

Here is the call graph for this function:

Here is the caller graph for this function:

getNumberOfVariables()

unsigned long paceval_cListOfVariables::getNumberOfVariables

(

)

gets the number of variable identifiers

Here is the call graph for this function:

Here is the caller graph for this function:

getVariable()

const char * paceval_cListOfVariables::getVariable ( unsigned long position_in )

private

gets the variable identifier at a position in the list

Parameters

position_in

specifies the position in the list

Here is the call graph for this function:

Here is the caller graph for this function:

identifyVariablePositionfromString()

long paceval_cListOfVariables::identifyVariablePositionfromString

(

const char *

variable_in

)

identifies the position of the variable identifier via the string

Here is the call graph for this function:

Here is the caller graph for this function:

initializeData()

void paceval_cListOfVariables::initializeData

(

unsigned long

proposedSize_in

)

initializes the size of the list

Parameters

proposedSize_in

specifies the initial size of the list

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

listOfPointers

paceval_cListOfPointer* paceval_cListOfVariables::listOfPointers

private

the list of pointers to the variable identifier strings

---

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

• paceval_cListOfVariables.h
• paceval_cListOfVariables.cpp