Detailed Description

This class represents a dimension on a layer in the WMS service metadata. It is not user-creatable but instead can either be retrieved from a TSLWMSServiceLayerDimension

Public Member Functions
const char *	getPossibleValue (int index) const

bool	getRange (int index, const char minimumValue, const char maximumValue, const char **resolution) const

const char *	name () const

int	noOfPossibleValues () const

int	noOfRanges () const

const char *	units () const

const char *	unitSymbol () const

bool	usesNearestValue () const

Member Function Documentation

◆ getPossibleValue()

const char * TSLWMSServiceLayerDimension::getPossibleValue ( int index ) const

Returns the Nth possible value for this dimension as defined by the WMS service metadata.

◆ getRange()

bool TSLWMSServiceLayerDimension::getRange	(	int	index,
		const char **	minimumValue,
		const char **	maximumValue,
		const char **	resolution ) const

Returns the Nth valid data range for this dimension as defined by the WMS service metadata.

Parameters

index	The index of the range to retrieve.
minimumValue	This will be set to a string that defines the lowest value of the valid range, in the units defined by the units() method.
maximumValue	This will be set to a string that defines the highest value of the valid range, in the units defined by the units() method.
resolution	This will be set to a string that defines the available increments between minimumValue and maximumValue n the units defined by the units() method.

◆ name()

const char * TSLWMSServiceLayerDimension::name ( ) const

Returns the name of this dimension.

◆ noOfPossibleValues()

int TSLWMSServiceLayerDimension::noOfPossibleValues ( ) const

Returns the number of potential values for this dimension as defined by the WMS service metadata.

If usesNearestValue() returns false then this defines the number of valid values for this dimension. If usesNearestValue() returns true then this method may return 0.

◆ noOfRanges()

int TSLWMSServiceLayerDimension::noOfRanges ( ) const

Returns the number of valid ranges for the value of this dimension as defined by the WMS service metadata. A dimension may have zero or more valid ranges.

◆ units()

const char * TSLWMSServiceLayerDimension::units ( ) const

Returns the units that this dimension is defined in.

◆ unitSymbol()

const char * TSLWMSServiceLayerDimension::unitSymbol ( ) const

Returns the unit symbol for this dimension if the service defines one. Otherwise, returns NULL.

◆ usesNearestValue()

bool TSLWMSServiceLayerDimension::usesNearestValue ( ) const

If this method returns true, the WMS service will use the nearest available value to the value set for this dimension when processing a request. Otherwise, only the values returned from getPossibleValue() can be set for this dimension, and specifying other values may generate a service error.