TSLS63CellPermitCollection Class Reference

Detailed Description

This class is a container for all cell permits within a single PERMIT.TXT file. Once a file has been loaded using the static create() method, individual cell permits can be queried.

Public Member Functions
const TSLS63CellPermit *	at (int index) const
void	destroy ()
const TSLS63CellPermit *	find (const char *cellName, const char *dsID=0) const
const TSLS63CellPermit *	operator[] (int index) const
int	size () const
bool	erase (unsigned int index)

Static Public Member Functions
static TSLS63CellPermitCollection *	create (const char *filename, TSLS63DataClient *dataClient)

Member Function Documentation

at()

const TSLS63CellPermit * TSLS63CellPermitCollection::at

(

int

index

)

const

Returns the cell permit at the given index in the container. If the index is invalid then this method will return NULL.

Parameters

index

The index of the cell permit to return.

create()

static TSLS63CellPermitCollection * TSLS63CellPermitCollection::create ( const char * filename, TSLS63DataClient * dataClient )

static

Loads and extracts all cell permit records contained within a single PERMIT.TXT file.

Parameters

filename	Full path including filename to the PERMIT.TXT file to load.
dataClient	The user implemented data client. If the format of the PERMIT.TXT file is invalid, this data client will be notified of the S63 error.

destroy()

void TSLS63CellPermitCollection::destroy

(

)

Deletes the cell permit collection. This method should be used rather than calling delete directly.

erase()

bool TSLS63CellPermitCollection::erase

(

unsigned int

index

)

Remove a cell permit from the collection

Parameters

index

The index of the cell permit to remove

Returns

true if the cell permit was removed, false otherwise

find()

const TSLS63CellPermit * TSLS63CellPermitCollection::find	(	const char *	cellName,
		const char *	dsID = 0 ) const

This function performs a lookup based upon the data server id and cell name. If a corresponding cell permit can be found it is returned, otherwise null is returned.

Parameters

cellName	The cell name
dsID	The null terminated 2 character data server id. This parameter may be null but will only match contained cell permits that have a null data server ID due to one not being present in the PERMIT.TXT file.

operator[]()

const TSLS63CellPermit * TSLS63CellPermitCollection::operator[]

(

int

index

)

const

Returns the cell permit at the given index in the container. If the index is invalid then this method will return NULL.

Parameters

index

The index of the cell permit to return.

size()

int TSLS63CellPermitCollection::size

(

)

const

Returns the number of cell permits loaded from a single PERMIT.TXT file.