Detailed Description

The TSLSatellite class represents the satellites.

Satellites are created by calling create on the TSLSatelliteManager.

Public Member Functions
bool	addCustomRendering (TSLCustomSatelliteHandler *cRender, bool renderAfter=false, bool assumeOwnership=false)

TSLSatelliteDataSet *	addDataSet ()

bool	addText (const TSLEntitySet *text)

double	bstar () const

const char *	classification () const

bool	clearRendering ()

const TSLSatelliteDataSet *	dataSet () const

TSLSatelliteDataSet *	dataSet ()

void	destroy ()

double	eccentricity () const

int	elementNumber () const

const char *	epoch () const

TSLFeatureID	featureID () const

void	featureID (TSLFeatureID newValue)

bool	getRendering (TSLRenderingAttributeInt attribute, int *result) const

bool	getRendering (TSLRenderingAttributeBool attribute, bool *result) const

bool	getRendering (TSLRenderingAttributeDouble attribute, double *result) const

double	inclination () const

const char *	intlDesignator () const

double	meanAnomaly () const

double	meanMotion () const

double	meanMotionFirstDerivative () const

double	meanMotionSecondDerivative () const

double	perigeeArgument () const

double	period () const

bool	position (const TSLTimeInstant &time, double &lat, double &lon, double &alt, TSLTimeHelper *timeHelper=0)

bool	position (double &lat, double &lon, double &alt) const

int	revNumber () const

double	rightAscension () const

const char *	satelliteName () const

int	satelliteNumber () const

bool	setRendering (TSLRenderingAttributeInt attribute, int value)

bool	setRendering (TSLRenderingAttributeBool attribute, bool value)

bool	setRendering (TSLRenderingAttributeDouble attribute, double value)

bool	addAttributeSet ()

Protected Member Functions
	~TSLSatellite ()

Constructor & Destructor Documentation

◆ ~TSLSatellite()

TSLSatellite::~TSLSatellite ( )

protected

Destructor.

Member Function Documentation

◆ addAttributeSet()

bool TSLSatellite::addAttributeSet ( )

◆ addCustomRendering()

bool TSLSatellite::addCustomRendering	(	TSLCustomSatelliteHandler *	cRender,
		bool	renderAfter = false,
		bool	assumeOwnership = false )

Add custom rendering to the satellite. This call replaces any existing custom rendering. If the existing custom rendering is owned by the satellite then it is destroyed.

Parameters

cRender	the custom handler to attach to the satellite.
renderAfter	by default false, causing the custom rendering to occur prior to the standard rendering, if set to true, the custom rendering occurs after the standard rendering

assumeOwnerhip. If true, the satellite assumes ownership of the custom renderer and will clone or destroy it when appropriate.

Returns: true if the custom rendering is successfully added, false otherwise.

◆ addDataSet()

TSLSatelliteDataSet * TSLSatellite::addDataSet ( )

Add a dataset to the satellite.

The added data set is returned.

If the satellite already has a data set the existing data set is returned.

◆ addText()

bool TSLSatellite::addText ( const TSLEntitySet * text )

Add text to a satellite.

Note that the entities added are copied and so subsequent modifications will not affect the rendering of the Satellite and the called is responsible for destroying the entity set passed in. This allows for the same labelling to be applied to many satellites.

Parameters

text	the entity set containing the text to add

◆ bstar()

double TSLSatellite::bstar ( ) const

Returns the BSTAR drag term of the satellite.

◆ classification()

const char * TSLSatellite::classification ( ) const

Returns the classification of the satellite.

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

◆ clearRendering()

bool TSLSatellite::clearRendering ( )

Clears any rendering attributes stored on this satellite. This means that the satellite will revert to any feature based rendering that is configured on the data layer or drawing surface.

◆ dataSet() [1/2]

TSLSatelliteDataSet * TSLSatellite::dataSet ( )

Return the non-const data set associated with this satellite.

◆ dataSet() [2/2]

const TSLSatelliteDataSet * TSLSatellite::dataSet ( ) const

Return the const data set associated with this satellite.

◆ destroy()

void TSLSatellite::destroy ( )

Destroy the satellite.

◆ eccentricity()

double TSLSatellite::eccentricity ( ) const

Returns the eccentricity of the satellite's orbit.

◆ elementNumber()

int TSLSatellite::elementNumber ( ) const

Returns the element number of the satellite, which is current for the element set loaded.

◆ epoch()

const char * TSLSatellite::epoch ( ) const

Returns the satellite's epoch.

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

◆ featureID() [1/2]

TSLFeatureID TSLSatellite::featureID ( ) const

Return the feature ID.

◆ featureID() [2/2]

void TSLSatellite::featureID ( TSLFeatureID newValue )

Set the feature ID.

Parameters

newValue the new feature ID to set

◆ getRendering() [1/3]

bool TSLSatellite::getRendering	(	TSLRenderingAttributeBool	attribute,
		bool *	result ) const

Gets the specified rendering attribute.

Parameters

attribute	Rendering attribute to query
result	Storage for returned value

Returns: true if rendering attribute was available and placed into result, false otherwise.

◆ getRendering() [2/3]

bool TSLSatellite::getRendering	(	TSLRenderingAttributeDouble	attribute,
		double *	result ) const

Gets the specified rendering attribute.

Parameters

attribute	Rendering attribute to query
result	Storage for returned value

Returns: true if rendering attribute was available and placed into result, false otherwise.

◆ getRendering() [3/3]

bool TSLSatellite::getRendering	(	TSLRenderingAttributeInt	attribute,
		int *	result ) const

Gets the specified rendering attribute.

Parameters

attribute	Rendering attribute to query
result	Storage for returned value

Returns: true if rendering attribute was available and placed into result, false otherwise.

◆ inclination()

double TSLSatellite::inclination ( ) const

Returns the inclination.

◆ intlDesignator()

const char * TSLSatellite::intlDesignator ( ) const

Returns the satellite's international designator.

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

◆ meanAnomaly()

double TSLSatellite::meanAnomaly ( ) const

Returns the mean anomaly.

◆ meanMotion()

double TSLSatellite::meanMotion ( ) const

Returns the satellite's mean motion (the number of revolutions per day).

◆ meanMotionFirstDerivative()

double TSLSatellite::meanMotionFirstDerivative ( ) const

Returns the first time derivative of the mean motion.

◆ meanMotionSecondDerivative()

double TSLSatellite::meanMotionSecondDerivative ( ) const

Returns the second time derivative of the mean motion.

◆ perigeeArgument()

double TSLSatellite::perigeeArgument ( ) const

Returns the argument of perigee.

◆ period()

double TSLSatellite::period ( ) const

Return the satellite's period, in minutes.

◆ position() [1/2]

bool TSLSatellite::position	(	const TSLTimeInstant &	time,
		double &	lat,
		double &	lon,
		double &	alt,
		TSLTimeHelper *	timeHelper = 0 )

Sets the satellite's position appropriate to a given time, and returns the new values. The latitude and longitude are returned in degrees and the altitude is returned in kilometres.

Parameters

time	the time to calculate the satellite position for
lat	the return latitude
lon	the return longitude
alt	the return altitude
timeHelper	the time helper - uses default time helper if not specified

Returns: true if lat/lon/alt are successfully populated, false otherwise. This typically returns false when the satellite has not yet had a position set.

◆ position() [2/2]

bool TSLSatellite::position	(	double &	lat,
		double &	lon,
		double &	alt ) const

Query the current position of the satellite, as set by the last update. The updates are typically triggered by a Time Server associated with the Data Layer containing the Satellite The latitude and longitude are returned in degrees and the altitude is returned in kilometres.

This method should not be called from either the TSL2DCustomSatellite Handler::render or TSL3DCustomSatelliteHandler::render but should use the position passed in.

Parameters

lat	the return latitude
lon	the return longitude
alt	the return altitude

Returns: true if lat/lon/alt are successfully populated, false otherwise. This typically returns false when the satellite has not yet had a position set.

◆ revNumber()

int TSLSatellite::revNumber ( ) const

Returns the satellite's revolution number at epoch.

◆ rightAscension()

double TSLSatellite::rightAscension ( ) const

Returns the right ascension.

◆ satelliteName()

const char * TSLSatellite::satelliteName ( ) const

Returns the satellite's name.

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

◆ satelliteNumber()

int TSLSatellite::satelliteNumber ( ) const

Returns the satellite's NORAD catalogue number.

◆ setRendering() [1/3]

bool TSLSatellite::setRendering	(	TSLRenderingAttributeBool	attribute,
		bool	value )

Sets the specified rendering attribute.

Parameters

attribute	Rendering attribute to set
value	New value for attribute

Returns: true if rendering attribute was available and updated, false otherwise.

◆ setRendering() [2/3]

bool TSLSatellite::setRendering	(	TSLRenderingAttributeDouble	attribute,
		double	value )

Sets the specified rendering attribute.

Parameters

attribute	Rendering attribute to set
value	New value for attribute

Returns: true if rendering attribute was available and updated, false otherwise.

◆ setRendering() [3/3]

bool TSLSatellite::setRendering	(	TSLRenderingAttributeInt	attribute,
		int	value )

Sets the specified rendering attribute.

Parameters

attribute	Rendering attribute to set
value	New value for attribute

Returns: true if rendering attribute was available and updated, false otherwise.

Detailed Description

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

◆ ~TSLSatellite()

Member Function Documentation

◆ addAttributeSet()

◆ addCustomRendering()

◆ addDataSet()

◆ addText()

◆ bstar()

◆ classification()

◆ clearRendering()

◆ dataSet() [1/2]

◆ dataSet() [2/2]

◆ destroy()

◆ eccentricity()

◆ elementNumber()

◆ epoch()

◆ featureID() [1/2]

◆ featureID() [2/2]

◆ getRendering() [1/3]

◆ getRendering() [2/3]

◆ getRendering() [3/3]

◆ inclination()

◆ intlDesignator()

◆ meanAnomaly()

◆ meanMotion()

◆ meanMotionFirstDerivative()

◆ meanMotionSecondDerivative()

◆ perigeeArgument()

◆ period()

◆ position() [1/2]

◆ position() [2/2]

◆ revNumber()

◆ rightAscension()

◆ satelliteName()

◆ satelliteNumber()

◆ setRendering() [1/3]

◆ setRendering() [2/3]

◆ setRendering() [3/3]