API Reference | OSGeo FDO Provider for GDAL |
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 /// <library>GRFPOverrides.lib</library> 00019 00020 #ifndef FDOGRFPRASTERBANDDEFINITION_H 00021 #define FDOGRFPRASTERBANDDEFINITION_H 00022 00023 #ifdef _WIN32 00024 #pragma once 00025 #endif //_WIN32 00026 00027 class FdoGrfpRasterExtents; 00028 class FdoGrfpRasterFeatureDefinition; 00029 class FdoGrfpRasterImageDefinition; 00030 00031 /// <summary> 00032 /// The FdoGrfpRasterBandDefinition class defines a raster band which contains a name 00033 /// and the extents of the raster band. 00034 /// </summary> 00035 class FdoGrfpRasterBandDefinition : public FdoPhysicalElementMapping 00036 { 00037 typedef FdoPhysicalElementMapping BaseType; 00038 00039 public: 00040 /// <summary>Constructs a new Raster Band Definition.</summary> 00041 /// <returns>Returns the newly created FdoGrfpRasterBandDefinition instance.</returns> 00042 FDOGRFP_API static FdoGrfpRasterBandDefinition* Create(); 00043 00044 /// <summary>Gets the raster image definition</summary> 00045 /// <returns>Returns the raster image definition. </returns> 00046 FDOGRFP_API FdoGrfpRasterImageDefinition* GetImage(); 00047 00048 /// <summary>Sets the raster image definition.</summary> 00049 /// <param name="imageDefinition">Input raster image definition</param> 00050 /// <returns>Returns nothing</returns> 00051 FDOGRFP_API void SetImage(FdoGrfpRasterImageDefinition* imageDefinition); 00052 00053 /// <summary>Gets the band number</summary> 00054 /// <returns>Returns the band number. </returns> 00055 FDOGRFP_API FdoInt32 GetBandNumber(); 00056 00057 /// <summary>Sets the band number.</summary> 00058 /// <param name="imageDefinition">Input band number</param> 00059 /// <returns>Returns nothing</returns> 00060 FDOGRFP_API void SetBandNumber(FdoInt32 bandNumber); 00061 00062 //DOM-IGNORE-BEGIN 00063 00064 // XML Serialization functions, not part of supported API. 00065 FDOGRFP_API virtual void InitFromXml(FdoXmlSaxContext* pContext, FdoXmlAttributeCollection* attrs); 00066 FDOGRFP_API virtual FdoXmlSaxHandler* XmlStartElement( 00067 FdoXmlSaxContext* context, 00068 FdoString* uri, 00069 FdoString* name, 00070 FdoString* qname, 00071 FdoXmlAttributeCollection* atts 00072 ); 00073 FDOGRFP_API virtual FdoBoolean XmlEndElement( 00074 FdoXmlSaxContext* context, 00075 FdoString* uri, 00076 FdoString* name, 00077 FdoString* qname 00078 ); 00079 FDOGRFP_API void _writeXml( FdoXmlWriter* xmlWriter, const FdoXmlFlags* flags ); 00080 00081 protected: 00082 FDOGRFP_API FdoGrfpRasterBandDefinition(void); 00083 FDOGRFP_API virtual ~FdoGrfpRasterBandDefinition(void); 00084 void Dispose(void); 00085 00086 private: 00087 FdoPtr<FdoGrfpRasterImageDefinition> m_imageDefinition; 00088 FdoInt32 m_bandNumber; 00089 00090 //DOM-IGNORE-END 00091 }; 00092 00093 /// <summary> FdoGrfpRasterBandDefinitionP is a FdoPtr on FdoGrfpRasterBandDefinition, provided for convenience. </summary> 00094 typedef FdoPtr<FdoGrfpRasterBandDefinition> FdoGrfpRasterBandDefinitionP; 00095 00096 00097 /// <summary> 00098 /// The FdoGrfpRasterBandCollection class holds a list of Raster Band Definition. 00099 /// </summary> 00100 class FdoGrfpRasterBandCollection : public FdoPhysicalElementMappingCollection<FdoGrfpRasterBandDefinition> 00101 { 00102 public: 00103 /// <summary>Constructs a new empty collection of Raster Band Definition.</summary> 00104 /// <param name="parent">Input parent object</param> 00105 /// <returns>Returns the newly created FdoGrfpRasterBandCollection instance.</returns> 00106 FDOGRFP_API static FdoGrfpRasterBandCollection* Create(FdoGrfpRasterFeatureDefinition *parent); 00107 00108 //DOM-IGNORE-BEGIN 00109 00110 protected: 00111 FdoGrfpRasterBandCollection(); 00112 FDOGRFP_API FdoGrfpRasterBandCollection(FdoGrfpRasterFeatureDefinition *parent); 00113 FDOGRFP_API virtual ~FdoGrfpRasterBandCollection(void); 00114 void Dispose(); 00115 00116 //DOM-IGNORE-END 00117 }; 00118 00119 /// <summary> FdoGrfpRasterBandsP is a FdoPtr on FdoGrfpRasterBandCollection, provided for convenience. </summary> 00120 typedef FdoPtr<FdoGrfpRasterBandCollection> FdoGrfpRasterBandsP; 00121 00122 #endif
Comments? |