OSGeo FDO Provider for Raster API Reference

OSGeo FDO Provider for Raster API

API Reference OSGeo FDO Provider for Raster

FdoRfpClassDefinition.h

Go to the documentation of this file.
00001 /*
00002  * (C) Copyright 2004 by Autodesk, Inc. All Rights Reserved.
00003  *
00004  * By using this code, you are agreeing to the terms and conditions of
00005  * the License Agreement included in the documentation for this code.
00006  *
00007  * AUTODESK MAKES NO WARRANTIES, EXPRESS OR IMPLIED, AS TO THE
00008  * CORRECTNESS OF THIS CODE OR ANY DERIVATIVE WORKS WHICH INCORPORATE
00009  * IT. AUTODESK PROVIDES THE CODE ON AN "AS-IS" BASIS AND EXPLICITLY
00010  * DISCLAIMS ANY LIABILITY, INCLUDING CONSEQUENTIAL AND INCIDENTAL
00011  * DAMAGES FOR ERRORS, OMISSIONS, AND OTHER PROBLEMS IN THE CODE.
00012  *
00013  * Use, duplication, or disclosure by the U.S. Government is subject
00014  * to restrictions set forth in FAR 52.227-19 (Commercial Computer
00015  * Software Restricted Rights) and DFAR 252.227-7013(c)(1)(ii)
00016  * (Rights in Technical Data and Computer Software), as applicable.
00017  *
00018  */
00019 #ifndef FDORFPCLASSDEFINITION_H
00020 #define FDORFPCLASSDEFINITION_H
00021 
00022 #ifdef _WIN32
00023 #pragma once
00024 #endif //_WIN32
00025 
00026 class FdoRfpRasterDefinition;
00027 class FdoRfpPhysicalSchemaMapping;
00028 
00029 /// \brief
00030 ///  
00031 /// The FdoRfpClassDefinition class defines overrides for a feature class that contains raster data.
00032 class FdoRfpClassDefinition : public FdoPhysicalClassMapping
00033 {
00034     typedef FdoPhysicalClassMapping BaseType;
00035 
00036 public:
00037     /// \brief
00038     /// Constructs a new empty class definition.
00039     /// 
00040     /// \return
00041     /// Returns the newly created FdoRfpClassDefinition instance.
00042     /// 
00043     FDORFP_API static FdoRfpClassDefinition* Create();
00044 
00045     /// \brief
00046     /// Gets the raster definition which contains a collection of raster locations.
00047     /// 
00048     /// \return
00049     /// Returns the raster definition. 
00050     /// 
00051     FDORFP_API FdoRfpRasterDefinition* GetRasterDefinition();
00052 
00053     /// \brief
00054     /// Sets the raster definition.
00055     /// 
00056     /// \param rasterDefinition 
00057     /// Input raster definition
00058     /// 
00059     /// \return
00060     /// Returns nothing
00061     /// 
00062     FDORFP_API void SetRasterDefinition(FdoRfpRasterDefinition* rasterDefinition);
00063     
00064 /// \cond DOXYGEN-IGNORE
00065 
00066     /// XML Serialization functions, not part of supported API.
00067     FDORFP_API virtual void InitFromXml(FdoXmlSaxContext* pContext, FdoXmlAttributeCollection* attrs);
00068     FDORFP_API virtual FdoXmlSaxHandler* XmlStartElement(
00069         FdoXmlSaxContext* context, 
00070         FdoString* uri, 
00071         FdoString* name, 
00072         FdoString* qname, 
00073         FdoXmlAttributeCollection* atts
00074     );
00075     FDORFP_API virtual FdoBoolean XmlEndElement(FdoXmlSaxContext* context, FdoString* uri, FdoString* name, FdoString* qname);
00076     FDORFP_API void _writeXml( FdoXmlWriter* xmlWriter, const FdoXmlFlags* flags );
00077 
00078 protected:
00079     FDORFP_API FdoRfpClassDefinition(void);
00080     FDORFP_API virtual ~FdoRfpClassDefinition(void);
00081     void Dispose(void);
00082 
00083 private:
00084     FdoPtr<FdoRfpRasterDefinition> m_rasterDefinition;
00085 
00086 /// \endcond
00087 
00088 };
00089 
00090 /// \brief
00091 ///  FdoRfpClassDefinitionP is a FdoPtr on FdoRfpClassDefinition, provided for convenience. 
00092 typedef FdoPtr<FdoRfpClassDefinition> FdoRfpClassDefinitionP;
00093 
00094 /// \brief
00095 ///  
00096 /// The FdoRfpClassCollection holds a list of class definitions.
00097 class FdoRfpClassCollection : public FdoPhysicalElementMappingCollection<FdoRfpClassDefinition>
00098 {
00099 public:
00100     /// \brief
00101     /// Constructs a new empty Class Definition collection.
00102     /// 
00103     /// \param parent 
00104     /// Input parent object
00105     /// 
00106     /// \return
00107     /// Returns the newly created FdoRfpClassCollection instance.
00108     /// 
00109     FDORFP_API static FdoRfpClassCollection* Create(FdoRfpPhysicalSchemaMapping *parent);
00110 
00111 /// \cond DOXYGEN-IGNORE
00112 
00113 protected:
00114     FdoRfpClassCollection();
00115     FDORFP_API FdoRfpClassCollection(FdoRfpPhysicalSchemaMapping *parent);
00116     FDORFP_API virtual ~FdoRfpClassCollection(void);
00117     void Dispose();
00118 
00119 /// \endcond
00120 
00121 };
00122 
00123 /// \brief
00124 ///  FdoRfpClassesP is a FdoPtr on FdoRfpClassCollection, provided for convenience. 
00125 typedef FdoPtr<FdoRfpClassCollection> FdoRfpClassesP;
00126 
00127 #endif
00128 
00129 

Comments?