paceval_cListOfPointer Class Reference

The class paceval_cListOfPointer is derived from paceval_cRegisteredObject and encapsulates the storage of a list of pointers to objects, such as the list of nodes in paceval_cGraph, the list of pointers in paceval_cListOfVariables or the list of registered objects in paceval_cCleanupHandler. More...

#include "inc/paceval_cListOfPointer.h"

Inheritance diagram for paceval_cListOfPointer:

Collaboration diagram for paceval_cListOfPointer:

Public Member Functions
	paceval_cListOfPointer (paceval_cCleanupHandler *handle_CleanupHandler_in)
void	initializeData (unsigned long proposedSize_in)
	~paceval_cListOfPointer ()
bool	doAddPointer (void *handle_Pointer_in, paceval_eListOfPointerTypes ePointerType_in, unsigned long *pointerPosition_out)
paceval_eListOfPointerTypes	getPointerType (unsigned long position_in)
void *	getPointer (unsigned long position_in)
bool	removePointer (unsigned long position_in)
unsigned long	sizeOf ()
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
bool	doIncreaseSize ()

Private Attributes
unsigned int	size_voidPointer
unsigned int	size_eListOfPointerTypes
void **	arrayOfPointer
paceval_eListOfPointerTypes *	arrayOfPointerTypes
unsigned long	size_arrayOfPointer
unsigned long	sizeUsed_arrayOfPointer
unsigned long	increaseCounter

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

Detailed Description

The class paceval_cListOfPointer is derived from paceval_cRegisteredObject and encapsulates the storage of a list of pointers to objects, such as the list of nodes in paceval_cGraph, the list of pointers in paceval_cListOfVariables or the list of registered objects in paceval_cCleanupHandler.

Constructor & Destructor Documentation

paceval_cListOfPointer()

paceval_cListOfPointer::paceval_cListOfPointer

(

paceval_cCleanupHandler *

handle_CleanupHandler_in

)

the constructor of paceval_cListOfPointer

Parameters

handle_CleanupHandler_in

is the associated handler for deleting this registered object

~paceval_cListOfPointer()

paceval_cListOfPointer::~paceval_cListOfPointer

(

)

the destructor of paceval_cListOfPointer

Member Function Documentation

doAddPointer()

bool paceval_cListOfPointer::doAddPointer	(	void *	handle_Pointer_in,
		paceval_eListOfPointerTypes	ePointerType_in,
		unsigned long *	pointerPosition_out )

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

Parameters

handle_Pointer_in	specifies the pointer to be added to the list
ePointerType_in	specifies the type of pointer of the object to add to the node list
pointerPosition_out	this buffer retrieves the position of the added pointer in the list

Here is the call graph for this function:

Here is the caller graph for this function:

doIncreaseSize()

bool paceval_cListOfPointer::doIncreaseSize ( )

private

increases the size of the array of pointers

Here is the caller graph for this function:

getPointer()

void * paceval_cListOfPointer::getPointer

(

unsigned long

position_in

)

gets the pointer at a position in the list

Parameters

position_in

specifies the position in the list

Here is the caller graph for this function:

getPointerType()

paceval_eListOfPointerTypes paceval_cListOfPointer::getPointerType

(

unsigned long

position_in

)

gets the type of the pointer at a position in the list

Parameters

position_in

specifies the position in the list

Here is the caller graph for this function:

initializeData()

void paceval_cListOfPointer::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:

removePointer()

bool paceval_cListOfPointer::removePointer

(

unsigned long

position_in

)

removes the pointer from a position in the list

Parameters

position_in

specifies the position in the list

Here is the caller graph for this function:

sizeOf()

unsigned long paceval_cListOfPointer::sizeOf

(

)

returns the size of the list of pointers, i.e. the number of pointers stored in the list

Here is the caller graph for this function:

Member Data Documentation

arrayOfPointer

void** paceval_cListOfPointer::arrayOfPointer

private

the dynamic array of pointers

arrayOfPointerTypes

paceval_eListOfPointerTypes* paceval_cListOfPointer::arrayOfPointerTypes

private

the dynamic array of pointer types associated with the array of pointers

increaseCounter

unsigned long paceval_cListOfPointer::increaseCounter

private

stores the counter of how many times the array of pointers was increased

size_arrayOfPointer

unsigned long paceval_cListOfPointer::size_arrayOfPointer

private

the current size of the array of pointers

size_eListOfPointerTypes

unsigned int paceval_cListOfPointer::size_eListOfPointerTypes

private

stores the size of paceval_eListOfPointerTypes in this system, means sizeof(paceval_eListOfPointerTypes)

size_voidPointer

unsigned int paceval_cListOfPointer::size_voidPointer

private

stores the size of a pointer in this system, means sizeof(void*)

sizeUsed_arrayOfPointer

unsigned long paceval_cListOfPointer::sizeUsed_arrayOfPointer

private

the currently used size of the array of pointers

---

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

• paceval_cListOfPointer.h
• paceval_cListOfPointer.cpp