TSLSatelliteManager Struct Reference

Detailed Description

The TSLSatelliteManager loads TLE files and is used to create satellites.

When creating satellites, the caller is responsible for the memory.

Public Member Functions
	TSLSatelliteManager ()
bool	clearSatellites ()
TSLSatellite *	create (const char *satelliteID)
TSLSatellite *	create (int index)
void	destroy ()
const char *	internationalDesignatorOfSatellite (int index) const
bool	loadTLEFiles (const char **tles, int numTles)
const char *	nameOfSatellite (int index) const
int	numberOfAvailableSatellites () const
const char *	satelliteID (const char *satName)
const char *	satelliteID (int index)
void *	operator new (size_t size)
void	operator delete (void *pMem)
void *	operator new (size_t size, char *filename, int line)

Constructor & Destructor Documentation

TSLSatelliteManager()

TSLSatelliteManager::TSLSatelliteManager

(

)

Constructor.

Member Function Documentation

clearSatellites()

bool TSLSatelliteManager::clearSatellites

(

)

Removes all satellites from the list of possible satellites a manager can create.

This call could be used prior to loading new TLE files for satellites.

Returns true on success, false if the clear fails.

create() [1/2]

TSLSatellite * TSLSatelliteManager::create

(

const char *

satelliteID

)

Create a satellite, given the satellite's NORAD catalogue number.

Parameters

satelliteID

the satellite's ID (as a string) - see 'satelliteID' methods

Returns

null if the specified satellite does not exist in the current set of TLE files loaded.

create() [2/2]

TSLSatellite * TSLSatelliteManager::create

(

int

index

)

Create a satellite, given the satellite index in the current TLE files loaded.

Parameters

index

index of the satellite to create

Returns

ID of the satellite, null if passed an invalid index.

destroy()

void TSLSatelliteManager::destroy

(

)

Delete the satellite manager.

internationalDesignatorOfSatellite()

const char * TSLSatelliteManager::internationalDesignatorOfSatellite

(

int

index

)

const

Returns the international designator of the satellite, given the satellite index in the current TLE files loaded.

Note that the returned string is held in static memory and may be overwritten by subsequent calls to this method.

Parameters

index

the index

Returns

NULL if an invalid index has been supplied.

loadTLEFiles()

bool TSLSatelliteManager::loadTLEFiles	(	const char **	tles,
		int	numTles )

Load two line element sets.

Parameters

tles	array of paths pointing to two line element sets.
numTles	the number of Two line element sets in the specified array

Returns

true on success, false if the load fails.

nameOfSatellite()

const char * TSLSatelliteManager::nameOfSatellite

(

int

index

)

const

Look up a satellite name, given the satellite index in the current TLE files loaded.

Note that the returned string is held in static memory and may be overwritten by subsequent calls to this method.

Returns null if passed an invalid index.

Parameters

index

the satellite's name to fetch

numberOfAvailableSatellites()

int TSLSatelliteManager::numberOfAvailableSatellites

(

)

const

Returns the number of satellites available from this manager.

operator delete()

void TSLSatelliteManager::operator delete

(

void *

pMem

)

operator new() [1/2]

void * TSLSatelliteManager::operator new

(

size_t

size

)

Allocation override for API redirection.

operator new() [2/2]

void * TSLSatelliteManager::operator new	(	size_t	size,
		char *	filename,
		int	line )

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.

satelliteID() [1/2]

const char * TSLSatelliteManager::satelliteID

(

const char *

satName

)

Look up a satellite ID, given the satellite name.

Note that the returned string is held in static memory and may be overwritten by subsequent calls to this method.

Returns null if passed an invalid index.

Parameters

satName

the satellite name

satelliteID() [2/2]

const char * TSLSatelliteManager::satelliteID

(

int

index

)

Look up a satellite ID, given the satellite index in the current TLE files loaded.

Note that the returned string is held in static memory and may be overwritten by subsequent calls to this method.

Parameters

index

index of the satellite to look up

Returns

ID of the satellite, null if passed an invalid index.