Detailed Description

The TSLSatelliteDataSet is used to contain text information associated with a satellite.

Public Member Functions
bool	addData (const TSLVariant *values, int count)

bool	addData (const TSLVariant &value)

const TSLVariant *	getData (int position, bool search_external=false) const

const TSLVariant *	getData (const char *id, int nth_copy=0, bool search_external=false) const

bool	removeData (int position)

bool	removeData (const char *id, int nth_copy=0)

int	sizeData (bool search_external=false) const

int	sizeData (const char *id, bool search_external=false) const

bool	updateData (const TSLVariant &value, int position)

bool	updateData (const TSLVariant &value, const char *id, int nth_copy=0)

Member Function Documentation

◆ addData() [1/2]

bool TSLSatelliteDataSet::addData ( const TSLVariant & value )

Handles the addition of a single variants to the TSLSatelliteDataSet. Addition is not allowed if the TSLSatelliteDataSet is read only.

Parameters value : reference to a single TSLVariant object to be added.

Returns True if data is successfully added, false otherwise.

◆ addData() [2/2]

bool TSLSatelliteDataSet::addData	(	const TSLVariant *	values,
		int	count )

Handles the addition of a set of variants to the TSLSatelliteDataSet. Addition is not allowed if the TSLSatelliteDataSet is read only.

Parameters values: pointer to the first of a set of TSLVariants count : number of TSLVariants being passed in pass

Returns True if successfully added, false otherwise.

◆ getData() [1/2]

const TSLVariant * TSLSatelliteDataSet::getData	(	const char *	id,
		int	nth_copy = 0,
		bool	search_external = false ) const

Gets the nth_copy of a data attribute identified by id. If search external is set it will also search any external data sources if available.

Parameters id : Identifier for the data element to be retrieved. This may be the two character code of the TSLVariant to retrieve or the human readable version of the code.

nth_copy :The count of the data identified by "id" to be retrieved. If no position is given the first occurance is to be retrieved.

search_external : Indicates if any external data sources should be searched. If no value is given no external search will be undertaken.

Returns a pointer to a TSLVariant with the given id at the requested position. Returns 0 if no valid data attribute was found.

◆ getData() [2/2]

const TSLVariant * TSLSatelliteDataSet::getData	(	int	position,
		bool	search_external = false ) const

Gets the data attribute at the position specified. If search external is set it will also search any external data sources if available.

Parameters position :The position of the data attribute to retrieve.

search_external : Indicates if any external data sources should be searched. If no value is given no external search will be undertaken.

Returns a pointer to a TSLVariant at the given position. Returns 0 if no valid data attribute was found.

◆ removeData() [1/2]

bool TSLSatelliteDataSet::removeData	(	const char *	id,
		int	nth_copy = 0 )

Removes nth_copy of the data attribute identified by the given id. Removal is not allowed if the TSLDataSet is read only as in the case of TSLDataSet for TSLEntities retrieved from a TSLMapDataLayer.

Parameters id : Identifier for the data element to be removed.

nth_copy : The index of the data attribute with the given id that is to be removed.

Returns True if the data attribute was found and removed, false otherwise.

◆ removeData() [2/2]

bool TSLSatelliteDataSet::removeData ( int position )

Removes data at the given position.

Removal is not allowed if the TSLDataSet is read only as in the case of TSLDataSet for TSLEntities retrieved from a TSLMapDataLayer.

Parameters position : the position of the data attribute to remove

Returns True if the data attribute was successfully removed, false otherwise.

◆ sizeData() [1/2]

int TSLSatelliteDataSet::sizeData ( bool search_external = false ) const

Counts the number of available items in the TSLDataSet

Parameters search_external : indicates if any external data sources should be searched when calculating the count.

Returns the number of data attributes stored.

◆ sizeData() [2/2]

int TSLSatelliteDataSet::sizeData	(	const char *	id,
		bool	search_external = false ) const

Counts the number of available items with the given id.

Parameters id : the id of the attribute to get search_external : indicates if any external data sources should be searched when calculating the count.

Returns the number of data items stored.

◆ updateData() [1/2]

bool TSLSatelliteDataSet::updateData	(	const TSLVariant &	value,
		const char *	id,
		int	nth_copy = 0 )

Updates the nth copy of the specific variant id.

Not allowed if the TSLDataSet is read only.

This will not allow changes to any of the MapLink specific attributes or to any external data items. Note that this does not change the 'key' or 'id', merely update the value.

Parameters value : reference to the TSLVariant object that is to update the TSLDataSet

id : Identifier for the data element to be updated. This may be the two character code of the TSLVariant to retrieve or the human readable version of the code.

nth_copy :The count of the data identified by "id" to be retrieved. If no position is given the first occurance is to be updated.

Returns True if the data was successfully updated. False otherwise.

◆ updateData() [2/2]

bool TSLSatelliteDataSet::updateData	(	const TSLVariant &	value,
		int	position )

Updates the variant at the specified position for the entity.