.NET API Reference OSGeo FDO Provider for WMS
Main Page | Namespace List | Alphabetical List | Class List | File List | Class Members | File Members

OvRasterDefinition Class Reference

#include <mgOvRasterDefinition.h>

List of all members.


Detailed Description

<summary> The FdoWmsOvRasterDefinition class defines the physical overrides for a raster property in a WMS FDO schema. </summary>

Definition at line 30 of file mgOvRasterDefinition.h.


Public Member Functions

__property System::String * get_BackgroundColor ()
__property System::String * get_ElevationDimension ()
__property NAMESPACE_OSGEO_FDO_PROVIDERS_WMS_OVERRIDE::OvFormatType get_FormatType ()
__property NAMESPACE_OSGEO_FDO_PROVIDERS_WMS_OVERRIDE::OvLayerCollection * get_Layers ()
__property System::String * get_SpatialContextName ()
__property System::String * get_TimeDimension ()
__property System::Boolean get_Transparent ()
 OvRasterDefinition ()
 <summary>Constructs a new Raster Definition.</summary>
__property System::Void set_BackgroundColor (System::String *bgColor)
__property System::Void set_ElevationDimension (System::String *dimension)
__property System::Void set_FormatType (NAMESPACE_OSGEO_FDO_PROVIDERS_WMS_OVERRIDE::OvFormatType value)
__property System::Void set_SpatialContextName (System::String *value)
__property System::Void set_TimeDimension (System::String *time)
__property System::Void set_Transparent (System::Boolean transparent)

Constructor & Destructor Documentation

OvRasterDefinition::OvRasterDefinition  ) 
 

<summary>Constructs a new Raster Definition.</summary>


Member Function Documentation

__property System::String* OvRasterDefinition::get_BackgroundColor  ) 
 

<summary>Gets the background color.</summary> <returns>Returns a System::String indicating the background color to be used when rendering the WMS image.</returns> <remarks>The background color is a string that specifies the color to be used as the background pixels of the map. The general format of the background color is a hexadecimal encoding of an RGB value where two hexadecimal characters are used for each of Red, Green, and Blue colour values. The values can range between 00 and FF for each (0 and 255, base 10). The format is 0xRRGGBB; either upper or lower case characters are allowed for RR, GG, and BB values. The "0x" prefix shall have a lower case ‘x? The default value is 0xFFFFFF (corresponding to the colour white).</remarks>

__property System::String* OvRasterDefinition::get_ElevationDimension  ) 
 

<summary>Gets the elevation dimension of the requested WMS map.</summary> <returns>Returns a System::String indicating the elevation dimension of the requested WMS image.</returns> <remarks>If a WMS Map has a Elevation dimension defined, then in order to retrieve the map in the required dimension, the dimension property may set to 'ELEVATION=value'.</remarks>

__property NAMESPACE_OSGEO_FDO_PROVIDERS_WMS_OVERRIDE::OvFormatType OvRasterDefinition::get_FormatType  ) 
 

<summary>Gets the format type in which the WMS image will be generated.</summary> <returns>Returns the WMS format type.</returns> <remarks>Allowed map formats are "picture" formats . Picture formats constitute a rectangular pixel array of fixed size. Picture formats include file types such as Portable Network Graphics (PNG), Joint Photographics Expert Group (JPEG) and file types such as Tagged Image File Format (TIFF).</remarks>

__property NAMESPACE_OSGEO_FDO_PROVIDERS_WMS_OVERRIDE::OvLayerCollection* OvRasterDefinition::get_Layers  ) 
 

<summary>Gets the WMS layers that will be used to construct the composite WMS image.</summary> <returns>Returns the collection of WMS layers associated to the logical FDO class definition.</returns> <remarks>A WMS shall render the requested layers by drawing the first map in the list bottommost, the next one over that, and so on.</remarks>

__property System::String* OvRasterDefinition::get_SpatialContextName  ) 
 

<summary>Gets the spatial context in which the requested WMS map will be returned.</summary> <returns>Returns the WMS Provider's spatial context name.</returns> <remarks>The same spatial context name applies to all layers in a single WMS class definition.</remarks>

__property System::String* OvRasterDefinition::get_TimeDimension  ) 
 

<summary>Gets the time dimension of the requested WMS map.</summary> <returns>Returns a System::String indicating the time dimension of the requested WMS image.</returns> <remarks>If a WMS map has a Time dimension defined, then requests may include the parameter TIME=value. For the TIME parameter, the special keyword 'current' may be used if the WMS Dimension:Name="time" service metadata element includes a nonzero value for the 'current' attribute. The expression "TIME=current" means send the most current data available. The expression "TIME=start_time/current" means send data from start_time up to the most current data available.</remarks>

__property System::Boolean OvRasterDefinition::get_Transparent  ) 
 

<summary>Gets the transparency state.</summary> <returns>Returns a FdoBoolean indicating the state of the transparency flag.</returns> <remarks>The transparency state specifies whether the WMS map background is to be made transparent or not. The default value is false. The ability to return an image drawn with transparent pixels allows results of different Map requests to be overlaid, producing a composite map. </remarks>

__property System::Void OvRasterDefinition::set_BackgroundColor System::String *  bgColor  ) 
 

<summary>Sets the background color.</summary> <returns>Returns nothing.</returns> <remarks>The background color is a string that specifies the color to be used as the background pixels of the map. The general format of the background color is a hexadecimal encoding of an RGB value where two hexadecimal characters are used for each of Red, Green, and Blue colour values. The values can range between 00 and FF for each (0 and 255, base 10). The format is 0xRRGGBB; either upper or lower case characters are allowed for RR, GG, and BB values. The "0x" prefix shall have a lower case ‘x? The default value is 0xFFFFFF (corresponding to the colour white).</remarks>

__property System::Void OvRasterDefinition::set_ElevationDimension System::String *  dimension  ) 
 

<summary>Sets the time dimension of the requested WMS map.</summary> <returns>Returns nothing.</returns> <returns>Returns a System::String indicating the elevation dimension of the requested WMS image.</returns> <remarks>If a WMS Map has a Elevation dimension defined, then in order to retrieve the map in the required dimension, the dimension property may set to 'ELEVATION=value'.</remarks>

__property System::Void OvRasterDefinition::set_FormatType NAMESPACE_OSGEO_FDO_PROVIDERS_WMS_OVERRIDE::OvFormatType  value  ) 
 

<summary>Sets the format type in which the WMS image will be generated.</summary> <returns>Returns nothing.</returns> <remarks>Allowed map formats are "picture" formats . Picture formats constitute a rectangular pixel array of fixed size. Picture formats include file types such as Portable Network Graphics (PNG), Joint Photographics Expert Group (JPEG) and file types such as Tagged Image File Format (TIFF).</remarks>

__property System::Void OvRasterDefinition::set_SpatialContextName System::String *  value  ) 
 

<summary>Sets the spatial context in which the requested WMS map will be returned.</summary> <returns>Returns nothing.</returns> <remarks>The same spatial context name applies to all layers in a single WMS class definition.</remarks>

__property System::Void OvRasterDefinition::set_TimeDimension System::String *  time  ) 
 

<summary>Sets the time dimension of the requested WMS map.</summary> <returns>Returns nothing .</returns> <remarks>If a WMS map has a Time dimension defined, then requests may include the parameter TIME=value. For the TIME parameter, the special keyword 'current' may be used if the WMS Dimension:Name="time" service metadata element includes a nonzero value for the 'current' attribute. The expression "TIME=current" means send the most current data available. The expression "TIME=start_time/current" means send data from start_time up to the most current data available.</remarks>

__property System::Void OvRasterDefinition::set_Transparent System::Boolean  transparent  ) 
 

<summary>Sets the transparency state.</summary> <returns>Returns nothing.</returns> <remarks>The transparency state specifies whether the WMS map background is to be made transparent or not. The default value is false. The ability to return an image drawn with transparent pixels allows results of different Map requests to be overlaid, producing a composite map. </remarks>


The documentation for this class was generated from the following file:
Comments?