ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.wmsserveredition.wmslayerplugin
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin
<!– Class –> 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
| Name | Parameters | DeclaringType | Summary |
|---|
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 WmsLayerPlugin | This is the default constructor for the WmsLayerPlugin class. |
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 Equals | Object | Object | |
| GetBoundingBox | String | This method returns the bounding box of the Layer. | |
| GetCapabilities | This method gets the general information about the plug-in itself. | ||
| GetFeatureInfo | GetFeatureInfoRequest, MapConfiguration, HttpContext | This method implements the WMS GetFeatureInfo operation and returns feature information depending on the request from client. | |
| GetGeographyUnit | String | This method returns the exact map unit (dependent on the crs) in order to support multiple projections. | |
| GetHashCode | Object | ||
| GetMap | GetMapRequest, MapConfiguration, HttpContext | Produce a map, which is defined as either a pictorial image or a set of graphical elements. | |
| 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 | |
| GetName | This method returns a single word used for machine-to-machine communication. | ||
| GetProjections | This method returns the projection string collection that are supported. | ||
| GetStyles | This method you need to return the styels that are supported. | ||
| GetTitle | This method returns the human-readable name of the WmsLayerPlugin. | ||
| GetType | Object | ||
| ToString | Object |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| Finalize | Object | ||
| GetBoundingBoxCore | String | This method returns the bounding box of the Layer. | |
| GetCapabilitiesCore | This method gets the general information about the plug-in itself. | ||
| GetFeatureInfoCore | GetFeatureInfoRequest, MapConfiguration, HttpContext | This method implements the WMS GetFeatureInfo operation and returns feature information depending on the request from client. | |
| GetGeographyUnitCore | String | This method returns 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 | |
| GetMapCore | GetMapRequest, MapConfiguration, HttpContext | Produce a map, which is defined as either a pictorial image or a set of graphical elements. | |
| GetNameCore | This method returns a single word used for machine-to-machine communication. | ||
| GetProjectionsCore | This method returns the projection string collection that are supported. | ||
| GetStylesCore | This method you need to return the styels that are supported. | ||
| GetTitleCore | This method returns the human-readable name of the WmsLayerPlugin. | ||
| MemberwiseClone | Object |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 BrowerCacheExpiration | TimeSpan | Represents the number of hours before the browser cache expires. | |
| JpegQuality | Int16 | Gets or sets the Jpeg quality , this property only take effects when setting the ImageFormat to Jpeg. | |
| WmsQueryMode | 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. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|
Public Events
| Name | Event Arguments | DeclaringType | 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
| Name | Type | Description |
|---|
Public Methods
Equals(Object)
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
GetBoundingBox(String)
This method returns the bounding box of the Layer.
Remarks
This method returns the bounding box of the Layer.
Return Value
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | This method returns the bounding box of the Layer. |
Parameters
| Name | Type | Description |
|---|---|---|
| crs | String<!– System.String –> | User gets the exact bounding box depend on crs in order to support multiple projections. |
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
GetCapabilities()
This method gets the general information about the plug-in itself.
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> | This method gets the general information about the plug-in itself. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
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
| Return Type | Description |
|---|---|
| String<!– System.String –> | This method returns feature information depending on the request from the client. |
Parameters
| Name | Type | Description |
|---|---|---|
| getFeatureInfoRequest | GetFeatureInfoRequest<!– ThinkGeo.MapSuite.WmsServerEdition.GetFeatureInfoRequest –> | The RequestInfo object corresponding to the QueryString from the client's request. |
| cachedMapConfiguration | MapConfiguration<!– ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration –> | MapConfiguration object from HttpContext.Application. |
| context | HttpContext<!– System.Web.HttpContext –> | 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. |
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
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
| Return Type | Description |
|---|---|
| GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> | This method returns the exact map unit (dependent on the crs) in order to support multiple projections. |
Parameters
| Name | Type | Description |
|---|---|---|
| crs | String<!– System.String –> | The user gets the exact map unit (dependent on the crs) in order to support multiple projections. |
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
GetHashCode()
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetMap(GetMapRequest, MapConfiguration, HttpContext)
Produce a map, which is defined as either a pictorial image or a set of graphical elements.
Return Value
| Return Type | Description |
|---|---|
| Bitmap<!– System.Drawing.Bitmap –> |
Parameters
| Name | Type | Description |
|---|---|---|
| getMapRequest | GetMapRequest<!– ThinkGeo.MapSuite.WmsServerEdition.GetMapRequest –> | The RequestInfo object corresponding to the QueryString from the client's request. |
| cachedMapConfiguration | MapConfiguration<!– ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration –> | MapConfiguration object from HttpContext.Application. |
| context | HttpContext<!– System.Web.HttpContext –> | 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. |
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
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
Return Value
| Return Type | Description |
|---|---|
| MapConfiguration<!– ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration –> | Return the MapConfiguration object which represents a layer backed by a group of layers depend on the style. |
Parameters
| Name | Type | Description |
|---|---|---|
| style | String<!– System.String –> | The style parameter string. |
| crs | String<!– System.String –> | The projectin parameter string. |
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
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
| Return Type | Description |
|---|---|
| String<!– System.String –> | This method returns a single word used for machine-to-machine communication. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
GetProjections()
This method returns the projection string collection that are supported.
Remarks
This method returns the projection string collection that are supported.
Return Value
| Return Type | Description |
|---|---|
| Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> | This method returns the projection string collection that are supported. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
GetStyles()
This method you need to return the styels that are supported.
Return Value
| Return Type | Description |
|---|---|
| Collection<WmsLayerStyle><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WmsServerEdition.WmsLayerStyle} –> | This method you need to return the styels that are supported. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
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
| Return Type | Description |
|---|---|
| String<!– System.String –> | This method returns the human-readable name of the WmsLayerPlugin. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
GetType()
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
ToString()
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Protected Methods
Finalize()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetBoundingBoxCore(String)
This method returns the bounding box of the Layer.
Remarks
This method returns the bounding box of the Layer.
Return Value
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | This method returns the bounding box of the Layer. |
Parameters
| Name | Type | Description |
|---|---|---|
| crs | String<!– System.String –> | User gets the exact bounding box depend on crs in order to support multiple projections. |
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
GetCapabilitiesCore()
This method gets the general information about the plug-in itself.
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> | This method gets the general information about the plug-in itself. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
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
| Return Type | Description |
|---|---|
| String<!– System.String –> | This method returns feature information depending on the request from the client. |
Parameters
| Name | Type | Description |
|---|---|---|
| getFeatureInfoRequest | GetFeatureInfoRequest<!– ThinkGeo.MapSuite.WmsServerEdition.GetFeatureInfoRequest –> | The RequestInfo object corresponding to the QueryString from the client's request. |
| cachedMapConfiguration | MapConfiguration<!– ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration –> | MapConfiguration object from HttpContext.Application. |
| context | HttpContext<!– System.Web.HttpContext –> | 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. |
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
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
| Return Type | Description |
|---|---|
| GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> | This method returns the exact map unit (dependent on the crs) in order to support multiple projections. |
Parameters
| Name | Type | Description |
|---|---|---|
| crs | String<!– System.String –> | The user gets the exact map unit (dependent on the crs) in order to support multiple projections. |
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
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
Return Value
| Return Type | Description |
|---|---|
| MapConfiguration<!– ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration –> | Return the MapConfiguration object which represents a layer backed by a group of layers depend on the style. |
Parameters
| Name | Type | Description |
|---|---|---|
| style | String<!– System.String –> | The style parameter string. |
| crs | String<!– System.String –> | The projectin parameter string. |
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
GetMapCore(GetMapRequest, MapConfiguration, HttpContext)
Produce a map, which is defined as either a pictorial image or a set of graphical elements.
Return Value
| Return Type | Description |
|---|---|
| Bitmap<!– System.Drawing.Bitmap –> |
Parameters
| Name | Type | Description |
|---|---|---|
| getMapRequest | GetMapRequest<!– ThinkGeo.MapSuite.WmsServerEdition.GetMapRequest –> | The RequestInfo object corresponding to the QueryString from the client's request. |
| cachedMapConfiguration | MapConfiguration<!– ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration –> | MapConfiguration object from HttpContext.Application. |
| context | HttpContext<!– System.Web.HttpContext –> | 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. |
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
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
| Return Type | Description |
|---|---|
| String<!– System.String –> | This method returns a single word used for machine-to-machine communication. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
GetProjectionsCore()
This method returns the projection string collection that are supported.
Remarks
This method returns the projection string collection that are supported.
Return Value
| Return Type | Description |
|---|---|
| Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> | This method returns the projection string collection that are supported. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
GetStylesCore()
This method you need to return the styels that are supported.
Return Value
| Return Type | Description |
|---|---|
| Collection<WmsLayerStyle><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WmsServerEdition.WmsLayerStyle} –> | This method you need to return the styels that are supported. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
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
| Return Type | Description |
|---|---|
| String<!– System.String –> | This method returns the human-readable name of the WmsLayerPlugin. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Public Properties
BrowerCacheExpiration
Represents the number of hours before the browser cache expires.
Return Value
| Return Type |
|---|
| TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
JpegQuality
Gets or sets the Jpeg quality , this property only take effects when setting the ImageFormat to Jpeg.
Return Value
| Return Type |
|---|
| Int16<!– System.Int16 –> |
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
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.
Return Value
| Return Type |
|---|
| WmsQueryMode<!– ThinkGeo.MapSuite.WmsServerEdition.WmsQueryMode –> |
<!– ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin –> Go Back
Protected Properties
Public Events
thinkgeo.mapsuite.wmsserveredition.wmslayerplugin.1440040136.txt.gz · Last modified: 2015/09/22 08:50 (external edit)