User Tools

Site Tools


thinkgeo.mapsuite.wmsserveredition.wmslayerplugin

ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin

Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.

This class is the base class for all types of WMS Plug-ins. The WmsLayerPlugin class is where all other types of WMS Plug-ins are inherited from. It provides the base set of functionality. As it is abstract, there are a number of methods you need to implement. The first one is GetMapConfigurationCore. In this method, you are responsible for generating a MapConfiguration which includes layers collection and TileCache object you will use. The other two required methods are GetProjectionCore and GetBoundingBoxCore. These get projection string and the BoundingBox for your WMS Plug-in. Another required method is GetNameCore which returns the layer name which will used in the GetMap WMS operation.

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin

Members Summary

Public Constructors

Protected Constructors

WmsLayerPlugin()

  • This is the default constructor for the WmsLayerPlugin class.
Remarks
  • This is the default constructor for the WmsLayerPlugin class.
Parameters

Public Methods

GetTitle()

  • This method returns the human-readable name of the WmsLayerPlugin.
Remarks
  • This method is the concrete wrapper for the virtual method GetTitleCore. It returns the human-readable name of the WmsLayerPlugin.
Return Value
  • Type:String
  • Description:This method returns the human-readable name of the WmsLayerPlugin.
Parameters

GetName()

  • This method returns a single word used for machine-to-machine communication.
Remarks
  • This method is the concrete wrapper for the abstract method GetNameCore. It returns returns a single word used for machine-to-machine communication.
Return Value
  • Type:String
  • Description:This method returns a single word used for machine-to-machine communication.
Parameters

GetProjections()

  • This method returns the projection string collection that are supported.
Remarks
  • This method returns the projection string collection that are supported.
Return Value
  • Type:Collection<String>
  • Description:This method returns the projection string collection that are supported.
Parameters

GetStyles()

  • This method you need to return the styels that are supported.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetStyles.28.29
Return Value
  • Type:Collection<WmsLayerStyle>
  • Description:This method you need to return the styels that are supported.
Parameters

GetGeographyUnit(String)

  • This method returns the exact map unit (dependent on the crs) in order to support multiple projections.
Remarks
  • This method returns the exact map unit (dependent on the crs) in order to support multiple projections.
Return Value
  • Description:This method returns the exact map unit (dependent on the crs) in order to support multiple projections.
Parameters
  • crs
    • Type:String
    • Description:The user gets the exact map unit (dependent on the crs) in order to support multiple projections.

GetMapConfiguration(String,String)

  • This method returns the MapConfiguration object which includes TileCache and Layers collection backed by a group of layers depend on the style, projection. This method is only called once per style and crs. In it you should create your layers and add them to the MapConfiguration. If you want to use tile caching you can also specify that in the MapConfiguration under the TileCache property. If you have setup multiple styles or projections this method will get called for each unique combination
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetMapConfiguration.28String.2C_String.29
Return Value
  • Description:Return the MapConfiguration object which represents a layer backed by a group of layers depend on the style.
Parameters
  • style
    • Type:String
    • Description:The style parameter string.
  • crs
    • Type:String
    • Description:The projectin parameter string.

GetBoundingBox(String)

  • This method returns the bounding box of the Layer.
Remarks
  • This method returns the bounding box of the Layer.
Return Value
  • Description:This method returns the bounding box of the Layer.
Parameters
  • crs
    • Type:String
    • Description:User gets the exact bounding box depend on crs in order to support multiple projections.

GetCapabilities()

  • This method gets the general information about the plug-in itself.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetCapabilities.28.29
Return Value
  • Type:String
  • Description:This method gets the general information about the plug-in itself.
Parameters

GetMap(GetMapRequest,MapConfiguration,HttpContext)

  • Produce a map, which is defined as either a pictorial image or a set of graphical elements.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetMap.28GetMapRequest.2C_MapConfiguration.2C_HttpContext.29
Return Value
  • Type:Bitmap
  • Description:N/A
Parameters
  • getMapRequest
    • Description:The RequestInfo object corresponding to the QueryString from the client's request.
  • cachedMapConfiguration
    • Description:MapConfiguration object from HttpContext.Application.
  • context
    • Type:HttpContext
    • Description:A System.Web.HttpContext object that provides references to the intrinsic server objects (for example: Request, Response, Session, and Server) used to service HTTP requests.

GetFeatureInfo(GetFeatureInfoRequest,MapConfiguration,HttpContext)

  • This method implements the WMS GetFeatureInfo operation and returns feature information depending on the request from client.
Remarks
  • This abstract method is called from the concrete public method GetFeatureInfo. The canonical use case for GetFeatureInfo is that a user sees the response of a GetMap request and chooses a point on that map for which to obtain more information. The basic operation provides the ability for a client to specify which pixel is being asked about, which layer(s) should be investigated, and what format the information should be returned in.
Return Value
  • Type:String
  • Description:This method returns feature information depending on the request from the client.
Parameters
  • getFeatureInfoRequest
    • Description:The RequestInfo object corresponding to the QueryString from the client's request.
  • cachedMapConfiguration
    • Description:MapConfiguration object from HttpContext.Application.
  • context
    • Type:HttpContext
    • Description:A System.Web.HttpContext object that provides references to the intrinsic server objects (for example: Request, Response, Session, and Server) used to service HTTP requests.

ToString()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#ToString.28.29
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#Equals.28Object.29
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetHashCode.28.29
Return Value
  • Type:Int32
  • Description:N/A
Parameters

GetType()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetType.28.29
Return Value
  • Type:Type
  • Description:N/A
Parameters

Protected Methods

GetTitleCore()

  • This method returns the human-readable name of the WmsLayerPlugin.
Remarks
  • This method is called from the concrete public method GetTitle. This method returns the human-readable name of the WmsLayerPlugin.
Return Value
  • Type:String
  • Description:This method returns the human-readable name of the WmsLayerPlugin.
Parameters

GetNameCore()

  • This method returns a single word used for machine-to-machine communication.
Remarks
  • This method is called from the concrete public method GetName. It returns a single word used for machine-to-machine communication.
Return Value
  • Type:String
  • Description:This method returns a single word used for machine-to-machine communication.
Parameters

GetProjectionsCore()

  • This method returns the projection string collection that are supported.
Remarks
  • This method returns the projection string collection that are supported.
Return Value
  • Type:Collection<String>
  • Description:This method returns the projection string collection that are supported.
Parameters

GetStylesCore()

  • This method you need to return the styels that are supported.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetStylesCore.28.29
Return Value
  • Type:Collection<WmsLayerStyle>
  • Description:This method you need to return the styels that are supported.
Parameters

GetGeographyUnitCore(String)

  • This method returns the exact map unit (dependent on the crs) in order to support multiple projections.
Remarks
  • This method returns the exact map unit (dependent on the crs) in order to support multiple projections.
Return Value
  • Description:This method returns the exact map unit (dependent on the crs) in order to support multiple projections.
Parameters
  • crs
    • Type:String
    • Description:The user gets the exact map unit (dependent on the crs) in order to support multiple projections.

GetMapConfigurationCore(String,String)

  • This method returns the MapConfiguration object which includes TileCache and Layers collection backed by a group of layers depend on the style, projection. This method is only called once per style and crs. In it you should create your layers and add them to the MapConfiguration. If you want to use tile caching you can also specify that in the MapConfiguration under the TileCache property. If you have setup multiple styles or projections this method will get called for each unique combination
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetMapConfigurationCore.28String.2C_String.29
Return Value
  • Description:Return the MapConfiguration object which represents a layer backed by a group of layers depend on the style.
Parameters
  • style
    • Type:String
    • Description:The style parameter string.
  • crs
    • Type:String
    • Description:The projectin parameter string.

GetBoundingBoxCore(String)

  • This method returns the bounding box of the Layer.
Remarks
  • This method returns the bounding box of the Layer.
Return Value
  • Description:This method returns the bounding box of the Layer.
Parameters
  • crs
    • Type:String
    • Description:User gets the exact bounding box depend on crs in order to support multiple projections.

GetCapabilitiesCore()

  • This method gets the general information about the plug-in itself.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetCapabilitiesCore.28.29
Return Value
  • Type:String
  • Description:This method gets the general information about the plug-in itself.
Parameters

GetMapCore(GetMapRequest,MapConfiguration,HttpContext)

  • Produce a map, which is defined as either a pictorial image or a set of graphical elements.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetMapCore.28GetMapRequest.2C_MapConfiguration.2C_HttpContext.29
Return Value
  • Type:Bitmap
  • Description:N/A
Parameters
  • getMapRequest
    • Description:The RequestInfo object corresponding to the QueryString from the client's request.
  • cachedMapConfiguration
    • Description:MapConfiguration object from HttpContext.Application.
  • context
    • Type:HttpContext
    • Description:A System.Web.HttpContext object that provides references to the intrinsic server objects (for example: Request, Response, Session, and Server) used to service HTTP requests.

GetFeatureInfoCore(GetFeatureInfoRequest,MapConfiguration,HttpContext)

  • This method implements the WMS GetFeatureInfo operation and returns feature information depending on the request from client.
Remarks
  • This abstract method is called from the concrete public method GetFeatureInfo. The canonical use case for GetFeatureInfo is that a user sees the response of a GetMap request and chooses a point on that map for which to obtain more information. The basic operation provides the ability for a client to specify which pixel is being asked about, which layer(s) should be investigated, and what format the information should be returned in.
Return Value
  • Type:String
  • Description:This method returns feature information depending on the request from the client.
Parameters
  • getFeatureInfoRequest
    • Description:The RequestInfo object corresponding to the QueryString from the client's request.
  • cachedMapConfiguration
    • Description:MapConfiguration object from HttpContext.Application.
  • context
    • Type:HttpContext
    • Description:A System.Web.HttpContext object that provides references to the intrinsic server objects (for example: Request, Response, Session, and Server) used to service HTTP requests.

Finalize()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#Finalize.28.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

MemberwiseClone()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#MemberwiseClone.28.29
Return Value
  • Type:Object
  • Description:N/A
Parameters

Public Properties

WmsQueryMode

This enumeration specifies whether a WmsLayerPlugin support GetFeatureInfo WMS operation or not. If it doesn't support GetFeatureInfo operation, and it will throw an Service Exception XML.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#WmsQueryMode

Return Value

JpegQuality

Gets or sets the Jpeg quality , this property only take effects when setting the ImageFormat to Jpeg.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#JpegQuality

Return Value
  • Type:Int16

BrowerCacheExpiration

Represents the number of hours before the browser cache expires.

Remarks
Return Value
  • Type:TimeSpan

Protected Properties

RRQ=

N/A

Remarks

N/A

Return Value
  • Type:String

Public Events

thinkgeo.mapsuite.wmsserveredition.wmslayerplugin.txt · Last modified: 2017/03/16 21:59 (external edit)