TSLOWCGMLOffering Class Reference

Inheritance diagram for TSLOWCGMLOffering:

Detailed Description

This class represents a GML document included either inline or referenced by URL as an offering in a context document. It offers methods to retrieve the content of the GML document and convert it to MapLink entities for further analysis.

Before offerings using this plugin can be used the application must unlock support for GML import using TSLUtilityFunctions::unlockSupport( TSLKeyed GML, ... ) using the licence key. See TSLUtilityFunctions::unlockSupport for more information on obtaining a licence key.

To use this class directly applications must link against the offering library (OWSCGMLOffering.lib on Windows, OWSCGMLOffering.so on other platforms). This is not necessary when only using the base TSLOWSOffering class retrieved from a TSLOWSContext.

Public Member Functions
	TSLOWCGMLOffering ()
virtual	~TSLOWCGMLOffering ()
TSLCoordinateSystem *	coordinateSystem () const
TSLStandardDataLayer *	convertToEntities (const TSLCoordinateSystem *coordSys) const
const TSLOWCContent *	gmlDocument () const
virtual TSLOWCOffering::OfferingTypeEnum	type () const
virtual TSLOWCOffering *	create ()
virtual bool	dataExtent (TSLEnvelope &extent, TSLCoordinateSystem *&coordinateSystem) const
virtual void	freeMemory (char *ptr)
virtual bool	readOperation (TSLOWCOperation *operation)
virtual bool	readInlineContent (TSLOWCContent *content)
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 void	addStyle (TSLOWCStyle *style)
virtual bool	activeStyle (unsigned int index)
virtual unsigned int	activeStyle () const
virtual void	clearStyles ()
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 }

Constructor & Destructor Documentation

TSLOWCGMLOffering()

TSLOWCGMLOffering::TSLOWCGMLOffering

(

)

~TSLOWCGMLOffering()

virtual TSLOWCGMLOffering::~TSLOWCGMLOffering ( )

virtual

Member Function Documentation

convertToEntities()

TSLStandardDataLayer * TSLOWCGMLOffering::convertToEntities

(

const TSLCoordinateSystem *

coordSys

)

const

Returns the contents of the GML offering converted to MapLink entities. The application assumes ownership of the returned data layer.

The entities are returned within a TSLStandardDataLayer to allow applications to access attribute definitions for features in the GML offering as well as their values.

Parameters

coordSys

The coordinate system that the MapLink entities should be created to match. This must be the same coordinate system as used by the GML document. If NULL, the conversion will use the same coordinate system as returned by the coordinateSystem() method.

coordinateSystem()

TSLCoordinateSystem * TSLOWCGMLOffering::coordinateSystem

(

)

const

Returns the coordinate system that the GML document from the offering is in. The application assumes ownership of the returned coordinate system.

Note that invoking this method requires parsing the GML document and therefore should not be called multiple times.

If the GML document does not define a coordinate system or the GML document cannot be read then this method returns NULL.

create()

virtual TSLOWCOffering * TSLOWCGMLOffering::create ( )

virtual

Implementation method for reading WMS offerings from a context document. Applications should not need to call these methods directly.

Implements TSLOWCOffering.

dataExtent()

virtual bool TSLOWCGMLOffering::dataExtent ( TSLEnvelope & extent, TSLCoordinateSystem *& coordinateSystem ) const

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.

Parameters

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.

freeMemory()

virtual void TSLOWCGMLOffering::freeMemory ( char * ptr )

virtual

This method will be invoked to delete memory previously returned from write ExtensionData().

Implements TSLOWCOffering.

gmlDocument()

const TSLOWCContent * TSLOWCGMLOffering::gmlDocument

(

)

const

Returns the content object that contains the raw GML document for this offering. This may be either a TSLOWCInlineContent object or a TSLOWCRemote Content object based on how the GML document is referenced by the offering.

readInlineContent()

virtual bool TSLOWCGMLOffering::readInlineContent ( TSLOWCContent * content )

virtual

This method will be invoked each time inline content is encountered on the offering. The default implementation does nothing.

Implementations should return true if they have taken ownership of the content object, or false if they have not.

Reimplemented from TSLOWCOffering.

readOperation()

virtual bool TSLOWCGMLOffering::readOperation ( TSLOWCOperation * operation )

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.

type()

virtual TSLOWCOffering::OfferingTypeEnum TSLOWCGMLOffering::type ( ) const

virtual

Returns TSLOWCOffering::GMLOffering

Implements TSLOWCOffering.

visualizeOffering()

virtual TSLDataLayerList * TSLOWCGMLOffering::visualizeOffering ( const TSLOWSContext * context, const TSLCoordinateSystem * coordSys ) const

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.

writeOperations()

virtual TSLOWSOperationList * TSLOWCGMLOffering::writeOperations ( TSLOWSContext::FormatEnum format )

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.