 |
MapLink Pro 11.1.1.0.
Envitia MapLink Pro: The Ultimate Mapping Application Toolkit
|
|
MapLink Pro 11.1.1.0.
Envitia MapLink Pro: The Ultimate Mapping Application Toolkit
|
This class represents a WMS service included as an offering in a context document. It offers methods that describe how the WMS is configured to match the contents of the equivalent offering in the document.
To use this class directly applications must link against the offering library (OWSCWMSOffering.lib on Windows, OWSCWMSOffering.so on other platforms). This is not necessary when only using the base TSLOWCOffering class retrieved from a TSLOWSContext.
Public Member Functions | |
| TSLOWCWMSOffering () | |
| virtual | ~TSLOWCWMSOffering () |
| unsigned int | bgColour () const |
| bool | bgColourValid () const |
| const char * | dimensionName (unsigned int index) const |
| const char * | dimensionValue (unsigned int index) const |
| const char * | dimensionValue (const char *name) const |
| const char * | format () const |
| const char * | getCapabilitiesURL () const |
| const char * | layerName (unsigned int index) const |
| const char * | layerStyle (unsigned int index) const |
| unsigned int | numDimensions () const |
| unsigned int | numLayers () const |
| const char * | srs () const |
| bool | transparent () const |
| virtual TSLOWCOffering::OfferingTypeEnum | type () const |
| virtual void | addStyle (TSLOWCStyle *style) |
| virtual TSLOWCOffering * | create () |
| virtual bool | dataExtent (TSLEnvelope &extent, TSLCoordinateSystem *&coordinateSystem) const |
| virtual void | freeMemory (char *ptr) |
| virtual bool | readOperation (TSLOWCOperation *operation) |
| virtual TSLDataLayerList * | visualizeOffering (const TSLOWSContext *context, const TSLCoordinateSystem *coordSys) const |
| virtual TSLOWSOperationList * | writeOperations (TSLOWSContext::FormatEnum format) |
 Public Member Functions inherited from TSLOWCOffering | |
| TSLOWCOffering () | |
| virtual | ~TSLOWCOffering () |
| virtual unsigned int | numStyles () const |
| virtual const TSLOWCStyle * | style (unsigned int index) const |
| virtual bool | activeStyle (unsigned int index) |
| virtual unsigned int | activeStyle () const |
| virtual void | clearStyles () |
| virtual bool | readInlineContent (TSLOWCContent *content) |
| virtual bool | readExtensionData (const char *data, unsigned int dataSize) |
| virtual char * | writeExtensionData (TSLOWSContext::FormatEnum format, unsigned int &length) |
Additional Inherited Members | |
| Public Types inherited from TSLOWCOffering | |
| enum | OfferingTypeEnum { UnknownOffering , UndefinedOffering , WMSOffering , WMTSOffering , GMLOffering } |
| TSLOWCWMSOffering::TSLOWCWMSOffering | ( | ) |
|
virtual |
|
virtual |
Adds a new style to the offering. The default implementation takes ownership of the style.
Derived offerings can override this method to recieve notifications of when new styles are added to the offering. Implementations should always call the base method unless the derived offering is reimplementing the storage of styles, in which case the numStyles, style and clearStyles methods must also be reimplemented.
Reimplemented from TSLOWCOffering.
| unsigned int TSLOWCWMSOffering::bgColour | ( | ) | const |
Returns the background colour that the WMS server should use. The TSLDecomposeRGB macro can be used to extract the components of the colour.
| bool TSLOWCWMSOffering::bgColourValid | ( | ) | const |
Returns true if the value returned from bgColour() represents a valid background colour, or false if the background colour was not specified for this WMS offering.
|
virtual |
Implementation method for reading WMS offerings from a context document. Applications should not need to call these methods directly.
Implements TSLOWCOffering.
|
virtual |
This method will be invoked as part of visualizing a context document through TSLOWSContextVisualizer::visualizeContextDocument().
Implementations should return the full extent of the data the offering represents and the coordinate system that the extent is in.
| extent | This should be set to the full extent of the data represented by the offering. |
| coordinateSystem | This should be set to the coordinate system that the extent is defined in. The OWS context SDK will assume ownership of the coordinate system. |
Implementations should return true if they have set the extent, or false if they cannot determine the extent of the data.
Implements TSLOWCOffering.
| const char * TSLOWCWMSOffering::dimensionName | ( | unsigned int | index | ) | const |
Returns the name of the dimension at the given index in this offering, or NULL if the given index is invalid.
| const char * TSLOWCWMSOffering::dimensionValue | ( | const char * | name | ) | const |
Returns the value of the dimension in this offering identified by the given name, or NULL if there is no dimension with this name specified for this offering.
| const char * TSLOWCWMSOffering::dimensionValue | ( | unsigned int | index | ) | const |
Returns the value of the dimension at the given index in this offering, or NULL if the given index is invalid.
| const char * TSLOWCWMSOffering::format | ( | ) | const |
Returns the MIME type that responses from the WMS server will be returned in.
|
virtual |
This method will be invoked to delete memory previously returned from write ExtensionData().
Implements TSLOWCOffering.
| const char * TSLOWCWMSOffering::getCapabilitiesURL | ( | ) | const |
Returns the URL to use to query the capabilities document of the WMS server represented by this offering.
| const char * TSLOWCWMSOffering::layerName | ( | unsigned int | index | ) | const |
Returns the name of the WMS layer from the request at the given index.
| const char * TSLOWCWMSOffering::layerStyle | ( | unsigned int | index | ) | const |
Returns the name of the style associated with the layer in the request at the given index.
Each layer has an associated style, therefore the valid index range is from 0 -> numLayers()-1.
| unsigned int TSLOWCWMSOffering::numDimensions | ( | ) | const |
Returns the number of dimensions from the WMS server that are used in this offering.
| unsigned int TSLOWCWMSOffering::numLayers | ( | ) | const |
Returns the number of layers from the WMS server that are used in this offering.
|
virtual |
This method will be invoked by the core parser once for each operation present on the offering. The offering should decode the contents of the operation into an easily consumable form.
Implements TSLOWCOffering.
| const char * TSLOWCWMSOffering::srs | ( | ) | const |
Returns the name of the coordinate system used as part of the WMS request.
| bool TSLOWCWMSOffering::transparent | ( | ) | const |
Returns true if images from the WMS server should be returned with a transparent background.
|
virtual |
Returns TSLOWCOffering::WMSOffering.
Implements TSLOWCOffering.
|
virtual |
This method will be invoked by the TSLOWSContextVisualizer when visualizin a context document. Implementations should create and return a set of MapLink data layers configured to match the offering.
The OWS context SDK will assume ownership of the returned layer list and the layers contained within it.
Implements TSLOWCOffering.
|
virtual |
This method will be invoked when writing a context document. The implementation should return a list of populated TSLOWSOperation classes that represent the offering's operations.
Implements TSLOWCOffering.
