OSGeo FDO Provider for MySQL API Reference

OSGeo FDO Provider for MySQL API

API Reference OSGeo FDO Provider for MySQL

MySqlOvGeometricColumn.h

Go to the documentation of this file.
00001 #ifndef FDO_MySQLOVGEOMETRICCOLUMN_H
00002 #define FDO_MySQLOVGEOMETRICCOLUMN_H
00003 //
00004 //
00005 // Copyright (C) 2004-2006  Autodesk, Inc.
00006 // 
00007 // This library is free software; you can redistribute it and/or
00008 // modify it under the terms of version 2.1 of the GNU Lesser
00009 // General Public License as published by the Free Software Foundation.
00010 // 
00011 // This library is distributed in the hope that it will be useful,
00012 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00013 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014 // Lesser General Public License for more details.
00015 // 
00016 // You should have received a copy of the GNU Lesser General Public
00017 // License along with this library; if not, write to the Free Software
00018 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00019 //
00020 #include <Rdbms/Override/MySQL/MySqlOv.h>
00021 #include <Rdbms/Override/RdbmsOvGeometricColumn.h>
00022 
00023 
00024 /// \brief
00025 /// Concrete class defining physical schema overrides for a geometric column.
00026 class FdoMySQLOvGeometricColumn : public FdoRdbmsOvGeometricColumn
00027 {
00028 public:
00029     /// \brief
00030     /// Constructs a default of an FdoMySQLOvGeometricColumn
00031     /// 
00032     /// \return
00033     /// Returns FdoMySQLOvGeometricColumn
00034     /// 
00035     FDOMYSQL_OV_API static FdoMySQLOvGeometricColumn* Create();
00036 
00037     /// \brief
00038     /// Constructs an instance of an FdoMySQLOvGeometricColumn using the specified arguments
00039     /// 
00040     /// \param name 
00041     /// Input name
00042     /// 
00043     /// \return
00044     /// Returns FdoMySQLOvGeometricColumn
00045     /// 
00046     FDOMYSQL_OV_API static FdoMySQLOvGeometricColumn* Create(FdoString* name);
00047 
00048 
00049 /// \cond DOXYGEN-IGNORE
00050 
00051     /// XML serialization functions, not part of the API.
00052 
00053     /// Initialize this element from its XML attributes
00054     virtual void InitFromXml(FdoXmlSaxContext* pContext, FdoXmlAttributeCollection* attrs);
00055 
00056     /// Serialize provider-specific parts of this override to XML
00057     virtual void _writeXmlContents(FdoXmlWriter* xmlWriter, const FdoXmlFlags* flags);
00058 /// \endcond
00059 
00060 protected:
00061     FdoMySQLOvGeometricColumn();
00062     FdoMySQLOvGeometricColumn(FdoString* name);
00063     virtual ~FdoMySQLOvGeometricColumn();
00064     virtual void Dispose();
00065 };
00066 
00067 /// \brief
00068 /// FdoMySQLOvGeometricColumnP is a FdoPtr on FdoMySQLOvGeometricColumn, provided for convenience.
00069 typedef FdoPtr<FdoMySQLOvGeometricColumn> FdoMySQLOvGeometricColumnP;
00070 
00071 #endif
00072 
00073 

Comments?