.NET API Reference | OSGeo FDO Provider for WMS |
00001 /* 00002 * Copyright (C) 2004-2006 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 NAMESPACE_OSGEO_FDO_PROVIDERS_WMS_OVERRIDE::OvFormatType get_FormatType(); 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_FormatType(NAMESPACE_OSGEO_FDO_PROVIDERS_WMS_OVERRIDE::OvFormatType 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 background color.</summary> 00069 /// <returns>Returns a System::String indicating the background color 00070 /// to be used when rendering the WMS image.</returns> 00071 /// <remarks>The background color is a string that specifies the color to be used 00072 /// as the background pixels of the map. The general format of the background color 00073 /// is a hexadecimal encoding of an RGB value where two hexadecimal characters 00074 /// are used for each of Red, Green, and Blue colour values. The values can range 00075 /// between 00 and FF for each (0 and 255, base 10). The format is 0xRRGGBB; either 00076 /// upper or lower case characters are allowed for RR, GG, and BB values. 00077 /// The "0x" prefix shall have a lower case ‘x? The default value is 0xFFFFFF 00078 /// (corresponding to the colour white).</remarks> 00079 __property System::String* get_BackgroundColor(); 00080 00081 /// <summary>Sets the background color.</summary> 00082 /// <returns>Returns nothing.</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::Void set_BackgroundColor(System::String* bgColor); 00092 00093 /// <summary>Gets the time dimension of the requested WMS map.</summary> 00094 /// <returns>Returns a System::String indicating the time dimension of the 00095 /// requested WMS image.</returns> 00096 /// <remarks>If a WMS map has a Time dimension defined, then requests may 00097 /// include the parameter TIME=value. For the TIME parameter, the special keyword 00098 /// 'current' may be used if the WMS Dimension:Name="time" service metadata 00099 /// element includes a nonzero value for the 'current' attribute. The expression 00100 /// "TIME=current" means send the most current data available. The expression 00101 /// "TIME=start_time/current" means send data from start_time up to the most 00102 /// current data available.</remarks> 00103 __property System::String* get_TimeDimension(); 00104 00105 /// <summary>Sets the time dimension of the requested WMS map.</summary> 00106 /// <returns>Returns nothing .</returns> 00107 /// <remarks>If a WMS map has a Time dimension defined, then requests may 00108 /// include the parameter TIME=value. For the TIME parameter, the special keyword 00109 /// 'current' may be used if the WMS Dimension:Name="time" service metadata 00110 /// element includes a nonzero value for the 'current' attribute. The expression 00111 /// "TIME=current" means send the most current data available. The expression 00112 /// "TIME=start_time/current" means send data from start_time up to the most 00113 /// current data available.</remarks> 00114 __property System::Void set_TimeDimension(System::String* time); 00115 00116 /// <summary>Gets the elevation dimension of the requested WMS map.</summary> 00117 /// <returns>Returns a System::String indicating the elevation dimension 00118 /// of the requested WMS image.</returns> 00119 /// <remarks>If a WMS Map has a Elevation dimension defined, then in 00120 /// order to retrieve the map in the required dimension, 00121 /// the dimension property may set to 'ELEVATION=value'.</remarks> 00122 __property System::String* get_ElevationDimension(); 00123 00124 /// <summary>Sets the time dimension of the requested WMS map.</summary> 00125 /// <returns>Returns nothing.</returns> 00126 /// <returns>Returns a System::String indicating the elevation dimension 00127 /// of the requested WMS image.</returns> 00128 /// <remarks>If a WMS Map has a Elevation dimension defined, then in 00129 /// order to retrieve the map in the required dimension, 00130 /// the dimension property may set to 'ELEVATION=value'.</remarks> 00131 __property System::Void set_ElevationDimension(System::String* dimension); 00132 00133 /// <summary>Gets the spatial context in which the requested 00134 /// WMS map will be returned.</summary> 00135 /// <returns>Returns the WMS Provider's spatial context name.</returns> 00136 /// <remarks>The same spatial context name applies to all layers 00137 /// in a single WMS class definition.</remarks> 00138 __property System::String* get_SpatialContextName(); 00139 00140 /// <summary>Sets the spatial context in which the requested 00141 /// WMS map will be returned.</summary> 00142 /// <returns>Returns nothing.</returns> 00143 /// <remarks>The same spatial context name applies to all layers 00144 /// in a single WMS class definition.</remarks> 00145 __property System::Void set_SpatialContextName(System::String* value); 00146 00147 /// <summary>Gets the WMS layers that will be used to construct 00148 /// the composite WMS image.</summary> 00149 /// <returns>Returns the collection of WMS layers associated to the logical 00150 /// FDO class definition.</returns> 00151 /// <remarks>A WMS shall render the requested layers by drawing 00152 /// the first map in the list bottommost, the next one over that, 00153 /// and so on.</remarks> 00154 __property NAMESPACE_OSGEO_FDO_PROVIDERS_WMS_OVERRIDE::OvLayerCollection* get_Layers(); 00155 00156 public private: 00157 OvRasterDefinition(System::IntPtr unmanaged, System::Boolean autoDelete); 00158 00159 inline FdoWmsOvRasterDefinition* GetImpObj(); 00160 }; 00161 00162 END_NAMESPACE_OSGEO_FDO_PROVIDERS_WMS_OVERRIDE
Comments? |