Detailed Description

This class represents a layer's custom dimension in the WMTS service metadata. It is not user-creatable but instead can either be retrieved from a TSLWMTSDataLayer, that has a service loaded, or is provided by most of the callbacks on the TSLWMTSServiceSettingsCallbacks abstract class.

To set the value that will be sent to the service for this dimension in requests, call TSLWMTSServiceLayer::setDimensionValue, with this dimension's identifier as the first argument.

Public Member Functions
const bool *	current () const

const char *	defaultValue () const

const char *	getValueAt (int index) const

const char *	identifier () const

int	numValues () const

const char *	unitSymbol () const

const char *	uom () const

Member Function Documentation

◆ current()

const bool * TSLWMTSServiceDimension::current ( ) const

Queries whether "current" is a valid value for this dimension. Returns NULL if setting is not present in capabilities, else returns pointer to the value.

◆ defaultValue()

const char * TSLWMTSServiceDimension::defaultValue ( ) const

The default value that will be used for this dimension if its value is not set, or is set to "default".

◆ getValueAt()

const char * TSLWMTSServiceDimension::getValueAt ( int index ) const

The Nth valid value defined by the service for this dimension.

Parameters

index The value to query - the user can find the range of valid values using the numValues function

On success, this method will return the Nth value. On failure, for instance due to the index being out of range, then null will be returned.

◆ identifier()

const char * TSLWMTSServiceDimension::identifier ( ) const

The identifier of this dimension.

◆ numValues()

int TSLWMTSServiceDimension::numValues ( ) const

The number of valid values defined by the service for this dimension.

◆ unitSymbol()

const char * TSLWMTSServiceDimension::unitSymbol ( ) const

The symbol to use for this dimension's unit. Returns NULL if setting is not present in capabilities, else returns pointer to the value.

◆ uom()

const char * TSLWMTSServiceDimension::uom ( ) const

The units of measure of this dimension. Returns NULL if setting is not present in capabilities, else returns pointer to the value.