TSLIslandSet Class Reference

Detailed Description

This class represents a collection of island objects. It does not, however, assume ownership of the islands.

Public Member Functions
	TSLIslandSet ()
	TSLIslandSet (const TSLIslandSet &other)
TSLIslandSet &	operator= (const TSLIslandSet &rhs)
void	add (TSLIsland *island)
void	clear ()
void	destroy (bool destroyIslands=false)
bool	empty () const
TSLIsland *	operator[] (int N)
const TSLIsland *	operator[] (int N) const
TSLIsland *	remove (int N)
Int	size () const
void *	operator new (size_t)
void	operator delete (void *)
void *	operator new (size_t, char *, int)

Constructor & Destructor Documentation

TSLIslandSet() [1/2]

TSLIslandSet::TSLIslandSet

(

)

Default constructor.

TSLIslandSet() [2/2]

TSLIslandSet::TSLIslandSet

(

const TSLIslandSet &

other

)

Copy constructor.

Member Function Documentation

add()

void TSLIslandSet::add

(

TSLIsland *

island

)

Inserts an island into the collection. The island is added at the end of the collection.

Parameters

island

A pointer to an island.

clear()

void TSLIslandSet::clear

(

)

Empties the collection. No islands are deleted as the collection does not own the islands.

destroy()

void TSLIslandSet::destroy

(

bool

destroyIslands = false

)

Used to delete the object.

Parameters

destroyIslands	If true, then all the island objects will be deleted.
Default	false.

empty()

bool TSLIslandSet::empty

(

)

const

Returns True if the collection is empty, False otherwise.

operator delete()

void TSLIslandSet::operator delete

(

void *

)

operator new() [1/2]

void * TSLIslandSet::operator new

(

size_t

)

Allocation override for API redirection.

operator new() [2/2]

void * TSLIslandSet::operator new	(	size_t	,
		char *	,
		int	)

When included in an MFC application in debug mode, the debug new expects this to be here. Override it and return the same as the normal one. The library must include it when compiled in release mode, since the user's application may be in debug mode.

operator=()

TSLIslandSet & TSLIslandSet::operator=

(

const TSLIslandSet &

rhs

)

Assignment operator.

operator[]() [1/2]

TSLIsland * TSLIslandSet::operator[]

(

int

N

)

Query method. Returns the Nth island in the collection.

Parameters

N	The index in the collection of the requested island.

operator[]() [2/2]

const TSLIsland * TSLIslandSet::operator[]

(

int

N

)

const

Query method (const). Returns the Nth island in the collection.

Parameters

N	The index in the collection of the requested island.

remove()

TSLIsland * TSLIslandSet::remove

(

int

N

)

Removes the Nth island from the collection. The island is returned to the caller.

Parameters

N	The index in the collection of the island to remove.

size()

Int TSLIslandSet::size

(

)

const

Returns the number of islands in the collection.