paceval_cUnsignedLongList Class Reference

The class paceval_cUnsignedLongList is derived from paceval_cRegisteredObject and encapsulates the management of an auto-expanding list of non-negative integer values with precision unsigned long. More...

#include "inc/paceval_cCleanupHandler.h"

Inheritance diagram for paceval_cUnsignedLongList:

Collaboration diagram for paceval_cUnsignedLongList:

Public Member Functions
	paceval_cUnsignedLongList (paceval_cCleanupHandler *handle_CleanupHandler_in)
void	initializeData ()
	~paceval_cUnsignedLongList ()
bool	doAddUnsignedLong (unsigned long valueUnsignedLong_in)
unsigned long *	getUnsignedLongPointer (unsigned long position_in)
bool	setUnsignedLong (unsigned long position_in, unsigned long valueUnsignedLong_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 ()

Protected Member Functions
bool	doIncreaseSize ()

Protected Attributes
unsigned long *	arrayOfUnsignedLong
unsigned long	size_arrayOfUnsignedLong
unsigned long	sizeUsed_arrayOfUnsignedLong
unsigned long	increaseCounter
Protected Attributes inherited from paceval_cRegisteredObject
paceval_cCleanupHandler *	handle_CleanupHandler
unsigned long	registerPosition

Detailed Description

The class paceval_cUnsignedLongList is derived from paceval_cRegisteredObject and encapsulates the management of an auto-expanding list of non-negative integer values with precision unsigned long.

Constructor & Destructor Documentation

paceval_cUnsignedLongList()

paceval_cUnsignedLongList::paceval_cUnsignedLongList

(

paceval_cCleanupHandler *

handle_CleanupHandler_in

)

the constructor of paceval_cUnsignedLongList

Parameters

handle_CleanupHandler_in

is the associated handler for deleting this registered object

~paceval_cUnsignedLongList()

paceval_cUnsignedLongList::~paceval_cUnsignedLongList

(

)

the destructor of paceval_cUnsignedLongList

Member Function Documentation

doAddUnsignedLong()

bool paceval_cUnsignedLongList::doAddUnsignedLong

(

unsigned long

valueUnsignedLong_in

)

adds a non-negative integer value to the list

Parameters

valueUnsignedLong_in

specifies the non-negative integer value to add to the list

Here is the call graph for this function:

Here is the caller graph for this function:

doIncreaseSize()

bool paceval_cUnsignedLongList::doIncreaseSize ( )

protected

expands the list

Here is the call graph for this function:

Here is the caller graph for this function:

getUnsignedLongPointer()

unsigned long * paceval_cUnsignedLongList::getUnsignedLongPointer

(

unsigned long

position_in

)

gets the pointer to the non-negative integer value at a given position in the list, or NULL if the position does not exist

Parameters

position_in

specifies the position in the list

Here is the caller graph for this function:

initializeData()

void paceval_cUnsignedLongList::initializeData

(

)

initializes the list

Here is the call graph for this function:

Here is the caller graph for this function:

setUnsignedLong()

bool paceval_cUnsignedLongList::setUnsignedLong	(	unsigned long	position_in,
		unsigned long	valueUnsignedLong_in )

puts a non-negative numerical value at a given position in the list and returns whether this was successful (true) or not (false)

Parameters

position_in	specifies the position in the list
valueUnsignedLong_in	specifies the non-negative integer value to set in the list

Here is the caller graph for this function:

sizeOf()

unsigned long paceval_cUnsignedLongList::sizeOf

(

)

queries the length of the list

Here is the caller graph for this function:

Member Data Documentation

arrayOfUnsignedLong

unsigned long* paceval_cUnsignedLongList::arrayOfUnsignedLong

protected

stores the list of non-negative integers

increaseCounter

unsigned long paceval_cUnsignedLongList::increaseCounter

protected

the number of times the list was automatically expanded

size_arrayOfUnsignedLong

unsigned long paceval_cUnsignedLongList::size_arrayOfUnsignedLong

protected

the actual size of the list

sizeUsed_arrayOfUnsignedLong

unsigned long paceval_cUnsignedLongList::sizeUsed_arrayOfUnsignedLong

protected

the number of occupied entries in the list

---

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

• paceval_cCleanupHandler.h
• paceval_cCleanupHandler.cpp