00001 /*
00002 * Copyright (C) 2004-2007 Autodesk, Inc.
00003 *
00004 * This library is free software; you can redistribute it and/or
00005 * modify it under the terms of version 2.1 of the GNU Lesser
00006 * General Public License as published by the Free Software Foundation.
00007 *
00008 * This library is distributed in the hope that it will be useful,
00009 * but WITHOUT ANY WARRANTY; without even the implied warranty of
00010 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
00011 * Lesser General Public License for more details.
00012 *
00013 * You should have received a copy of the GNU Lesser General Public
00014 * License along with this library; if not, write to the Free Software
00015 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00016 *
00017 *
00018 */
00019
00020 #pragma once
00021
00022 class FdoWmsOvRasterDefinition;
00023
00024 BEGIN_NAMESPACE_OSGEO_FDO_PROVIDERS_WMS_OVERRIDE
00025 public __gc class OvLayerCollection;
00026
00027 /// <summary>
00028 /// The FdoWmsOvRasterDefinition class defines the physical overrides for a raster property in a WMS FDO schema.
00029 /// </summary>
00030 public __gc class OvRasterDefinition : public NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalElementMapping
00031 {
00032 public:
00033 /// <summary>Constructs a new Raster Definition.</summary>
00034 OvRasterDefinition();
00035
00036 /// <summary>Gets the format type in which the WMS image will be generated.</summary>
00037 /// <returns>Returns the WMS format type.</returns>
00038 /// <remarks>Allowed map formats are "picture" formats . Picture formats constitute
00039 /// a rectangular pixel array of fixed size. Picture formats include file types such
00040 /// as Portable Network Graphics (PNG), Joint Photographics Expert Group (JPEG)
00041 /// and file types such as Tagged Image File Format (TIFF).</remarks>
00042 __property System::String* get_ImageFormat();
00043
00044 /// <summary>Sets the format type in which the WMS image will be generated.</summary>
00045 /// <returns>Returns nothing.</returns>
00046 /// <remarks>Allowed map formats are "picture" formats . Picture formats constitute
00047 /// a rectangular pixel array of fixed size. Picture formats include file types such
00048 /// as Portable Network Graphics (PNG), Joint Photographics Expert Group (JPEG)
00049 /// and file types such as Tagged Image File Format (TIFF).</remarks>
00050 __property System::Void set_ImageFormat(System::String* value);
00051
00052 /// <summary>Gets the transparency state.</summary>
00053 /// <returns>Returns a FdoBoolean indicating the state of the transparency flag.</returns>
00054 /// <remarks>The transparency state specifies whether the WMS map background is to
00055 /// be made transparent or not. The default value is false. The ability to return
00056 /// an image drawn with transparent pixels allows results of different Map requests
00057 /// to be overlaid, producing a composite map. </remarks>
00058 __property System::Boolean get_Transparent();
00059
00060 /// <summary>Sets the transparency state.</summary>
00061 /// <returns>Returns nothing.</returns>
00062 /// <remarks>The transparency state specifies whether the WMS map background is to
00063 /// be made transparent or not. The default value is false. The ability to return
00064 /// an image drawn with transparent pixels allows results of different Map requests
00065 /// to be overlaid, producing a composite map. </remarks>
00066 __property System::Void set_Transparent(System::Boolean transparent);
00067
00068 /// <summary> Gets the tile caching option value. </summary>
00069 /// <returns> Returns a FdoBoolean indicating whether using tile cache or not. </returns>
00070 /// <remarks> This option specifies whether using the tile caching method to query the raster data.
00071 /// The default value is true.</remarks>
00072 __property System::Boolean get_UseTileCache();
00073
00074 /// <summary> Sets the tile caching option value. </summary>
00075 /// <returns> Returns nothing. </returns>
00076 /// <remarks> This option specifies whether using the tile caching method to query the raster data.
00077 /// The default value is true.</remarks>
00078 __property System::Void set_UseTileCache(System::Boolean value);
00079
00080 /// <summary>Gets the background color.</summary>
00081 /// <returns>Returns a System::String indicating the background color
00082 /// to be used when rendering the WMS image.</returns>
00083 /// <remarks>The background color is a string that specifies the color to be used
00084 /// as the background pixels of the map. The general format of the background color
00085 /// is a hexadecimal encoding of an RGB value where two hexadecimal characters
00086 /// are used for each of Red, Green, and Blue colour values. The values can range
00087 /// between 00 and FF for each (0 and 255, base 10). The format is 0xRRGGBB; either
00088 /// upper or lower case characters are allowed for RR, GG, and BB values.
00089 /// The "0x" prefix shall have a lower case x? The default value is 0xFFFFFF
00090 /// (corresponding to the colour white).</remarks>
00091 __property System::String* get_BackgroundColor();
00092
00093 /// <summary>Sets the background color.</summary>
00094 /// <returns>Returns nothing.</returns>
00095 /// <remarks>The background color is a string that specifies the color to be used
00096 /// as the background pixels of the map. The general format of the background color
00097 /// is a hexadecimal encoding of an RGB value where two hexadecimal characters
00098 /// are used for each of Red, Green, and Blue colour values. The values can range
00099 /// between 00 and FF for each (0 and 255, base 10). The format is 0xRRGGBB; either
00100 /// upper or lower case characters are allowed for RR, GG, and BB values.
00101 /// The "0x" prefix shall have a lower case x? The default value is 0xFFFFFF
00102 /// (corresponding to the colour white).</remarks>
00103 __property System::Void set_BackgroundColor(System::String* bgColor);
00104
00105 /// <summary>Gets the time dimension of the requested WMS map.</summary>
00106 /// <returns>Returns a System::String indicating the time dimension of the
00107 /// requested WMS image.</returns>
00108 /// <remarks>If a WMS map has a Time dimension defined, then requests may
00109 /// include the parameter TIME=value. For the TIME parameter, the special keyword
00110 /// 'current' may be used if the WMS Dimension:Name="time" service metadata
00111 /// element includes a nonzero value for the 'current' attribute. The expression
00112 /// "TIME=current" means send the most current data available. The expression
00113 /// "TIME=start_time/current" means send data from start_time up to the most
00114 /// current data available.</remarks>
00115 __property System::String* get_TimeDimension();
00116
00117 /// <summary>Sets the time dimension of the requested WMS map.</summary>
00118 /// <returns>Returns nothing .</returns>
00119 /// <remarks>If a WMS map has a Time dimension defined, then requests may
00120 /// include the parameter TIME=value. For the TIME parameter, the special keyword
00121 /// 'current' may be used if the WMS Dimension:Name="time" service metadata
00122 /// element includes a nonzero value for the 'current' attribute. The expression
00123 /// "TIME=current" means send the most current data available. The expression
00124 /// "TIME=start_time/current" means send data from start_time up to the most
00125 /// current data available.</remarks>
00126 __property System::Void set_TimeDimension(System::String* time);
00127
00128 /// <summary>Gets the elevation dimension of the requested WMS map.</summary>
00129 /// <returns>Returns a System::String indicating the elevation dimension
00130 /// of the requested WMS image.</returns>
00131 /// <remarks>If a WMS Map has a Elevation dimension defined, then in
00132 /// order to retrieve the map in the required dimension,
00133 /// the dimension property may set to 'ELEVATION=value'.</remarks>
00134 __property System::String* get_ElevationDimension();
00135
00136 /// <summary>Sets the time dimension of the requested WMS map.</summary>
00137 /// <returns>Returns nothing.</returns>
00138 /// <returns>Returns a System::String indicating the elevation dimension
00139 /// of the requested WMS image.</returns>
00140 /// <remarks>If a WMS Map has a Elevation dimension defined, then in
00141 /// order to retrieve the map in the required dimension,
00142 /// the dimension property may set to 'ELEVATION=value'.</remarks>
00143 __property System::Void set_ElevationDimension(System::String* dimension);
00144
00145 /// <summary>Gets the spatial context in which the requested
00146 /// WMS map will be returned.</summary>
00147 /// <returns>Returns the WMS Provider's spatial context name.</returns>
00148 /// <remarks>The same spatial context name applies to all layers
00149 /// in a single WMS class definition.</remarks>
00150 __property System::String* get_SpatialContextName();
00151
00152 /// <summary>Sets the spatial context in which the requested
00153 /// WMS map will be returned.</summary>
00154 /// <returns>Returns nothing.</returns>
00155 /// <remarks>The same spatial context name applies to all layers
00156 /// in a single WMS class definition.</remarks>
00157 __property System::Void set_SpatialContextName(System::String* value);
00158
00159 /// <summary>Gets the WMS layers that will be used to construct
00160 /// the composite WMS image.</summary>
00161 /// <returns>Returns the collection of WMS layers associated to the logical
00162 /// FDO class definition.</returns>
00163 /// <remarks>A WMS shall render the requested layers by drawing
00164 /// the first map in the list bottommost, the next one over that,
00165 /// and so on.</remarks>
00166 __property NAMESPACE_OSGEO_FDO_PROVIDERS_WMS_OVERRIDE::OvLayerCollection* get_Layers();
00167
00168 public private:
00169 OvRasterDefinition(System::IntPtr unmanaged, System::Boolean autoDelete);
00170
00171 inline FdoWmsOvRasterDefinition* GetImpObj();
00172 };
00173
00174 END_NAMESPACE_OSGEO_FDO_PROVIDERS_WMS_OVERRIDE