MigrationAreaPtrVector Class Reference

This class implements a dynamic vector of MigrationArea values. More...

#include <migrationareaptrvector.h>

Collaboration diagram for MigrationAreaPtrVector:

Public Member Functions
	MigrationAreaPtrVector ()
	This is the default MigrationAreaPtrVector constructor. More...
	MigrationAreaPtrVector (const MigrationAreaPtrVector &initial)
	This is the MigrationAreaPtrVector constructor that creates a copy of an existing MigrationAreaPtrVector. More...
	~MigrationAreaPtrVector ()
	This is the MigrationAreaPtrVector destructor. More...
void	resize (MigrationArea *value)
	This will add one new entry to the vector. More...
void	Delete (int pos)
	This will delete an entry from the vector. More...
int	Size () const
	This will return the size of the vector. More...
MigrationArea *&	operator[] (int pos)
	This will return the value of an element of the vector. More...
MigrationArea *const &	operator[] (int pos) const
	This will return the value of an element of the vector. More...

Protected Attributes
MigrationArea **	v
	This is the vector of MigrationArea values. More...
int	size
	This is the size of the vector. More...

Detailed Description

This class implements a dynamic vector of MigrationArea values.

Constructor & Destructor Documentation

MigrationAreaPtrVector() [1/2]

MigrationAreaPtrVector::MigrationAreaPtrVector ( )

inline

This is the default MigrationAreaPtrVector constructor.

MigrationAreaPtrVector() [2/2]

MigrationAreaPtrVector::MigrationAreaPtrVector

(

const MigrationAreaPtrVector &

initial

)

This is the MigrationAreaPtrVector constructor that creates a copy of an existing MigrationAreaPtrVector.

Parameters

initial

is the MigrationAreaPtrVector to copy

~MigrationAreaPtrVector()

MigrationAreaPtrVector::~MigrationAreaPtrVector

(

)

This is the MigrationAreaPtrVector destructor.

Note

This will free all the memory allocated to all the elements of the vector

Member Function Documentation

Delete()

void MigrationAreaPtrVector::Delete

(

int

pos

)

This will delete an entry from the vector.

Parameters

pos	is the element of the vector to be deleted

Note

This will free the memory allocated to the deleted element of the vector

operator[]() [1/2]

MigrationArea*& MigrationAreaPtrVector::operator[] ( int  pos )

inline

This will return the value of an element of the vector.

Parameters

pos	is the element of the vector to be returned

Returns

the value of the specified element

operator[]() [2/2]

MigrationArea* const& MigrationAreaPtrVector::operator[] ( int  pos ) const

inline

This will return the value of an element of the vector.

Parameters

pos	is the element of the vector to be returned

Returns

the value of the specified element

resize()

void MigrationAreaPtrVector::resize

(

MigrationArea *

value

)

This will add one new entry to the vector.

Parameters

value

is the value that will be entered for the new entry

Size()

int MigrationAreaPtrVector::Size ( ) const

inline

This will return the size of the vector.

Returns

the size of the vector

Member Data Documentation

size

int MigrationAreaPtrVector::size

protected

This is the size of the vector.

v

MigrationArea** MigrationAreaPtrVector::v

protected

This is the vector of MigrationArea values.

---

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

• src/include/migrationareaptrvector.h
• src/migrationareaptrvector.cc