OSGeo FDO Provider for ODBC API Reference

OSGeo FDO Provider for ODBC API

API Reference OSGeo FDO Provider for ODBC

OdbcOvDataPropertyDefinition.h

Go to the documentation of this file.
00001 #ifndef FDO_OdbcOVDATAPROPERTYDEFINITION_H
00002 #define FDO_OdbcOVDATAPROPERTYDEFINITION_H
00003 
00004 //
00005 //
00006 // Copyright (C) 2004-2006  Autodesk, Inc.
00007 // 
00008 // This library is free software; you can redistribute it and/or
00009 // modify it under the terms of version 2.1 of the GNU Lesser
00010 // General Public License as published by the Free Software Foundation.
00011 // 
00012 // This library is distributed in the hope that it will be useful,
00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015 // Lesser General Public License for more details.
00016 // 
00017 // You should have received a copy of the GNU Lesser General Public
00018 // License along with this library; if not, write to the Free Software
00019 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00020 //
00021 #include <FdoCommon.h>
00022 #include <Rdbms/Override/RdbmsOvDataPropertyDefinition.h>
00023 #include <Rdbms/Override/ODBC/OdbcOv.h>
00024 #include <Rdbms/Override/ODBC/OdbcOvColumn.h>
00025 #include <Rdbms/Override/ODBC/OdbcOvPropertyDefinition.h>
00026 
00027 /// \brief
00028 /// Concrete class defining physical schema overrides for a data property definition.
00029 class FdoOdbcOvDataPropertyDefinition : public FdoRdbmsOvDataPropertyDefinition, public FdoOdbcOvPropertyDefinition
00030 {
00031 public:
00032     /// \brief
00033     /// Constructs a default of an FdoOdbcOvDataPropertyDefinition
00034     /// 
00035     /// \return
00036     /// Returns FdoOdbcOvDataPropertyDefinition
00037     /// 
00038     FDOODBC_OV_API static FdoOdbcOvDataPropertyDefinition* Create();
00039 
00040     /// \brief
00041     /// Constructs an instance of an FdoOdbcOvDataPropertyDefinition using the specified arguments
00042     /// 
00043     /// \param name 
00044     /// Input name
00045     /// 
00046     /// \return
00047     /// Returns FdoOdbcOvDataPropertyDefinition
00048     /// 
00049     FDOODBC_OV_API static FdoOdbcOvDataPropertyDefinition* Create(FdoString* name);
00050 
00051     /// \brief
00052     /// Gets the Odbc column
00053     /// 
00054     /// \return
00055     /// Returns the Odbc column
00056     /// 
00057     FDOODBC_OV_API FdoOdbcOvColumn* GetColumn();
00058 
00059     /// \brief
00060     /// Sets the Odbc column
00061     /// 
00062     /// \return
00063     /// Returns nothing
00064     /// 
00065     FDOODBC_OV_API void SetColumn(FdoOdbcOvColumn *column);
00066 
00067 /// \cond DOXYGEN-IGNORE
00068 
00069 /// \endcond
00070 
00071 protected:
00072     FdoOdbcOvDataPropertyDefinition();
00073     FdoOdbcOvDataPropertyDefinition(FdoString* name);
00074     virtual ~FdoOdbcOvDataPropertyDefinition();
00075     virtual void Dispose();
00076 
00077 private:
00078 };
00079 
00080 
00081 /// \brief
00082 /// FdoOdbcOvDataPropertyP is a FdoPtr on FdoOdbcOvDataPropertyDefinition, provided for convenience.
00083 typedef FdoPtr<FdoOdbcOvDataPropertyDefinition> FdoOdbcOvDataPropertyP;
00084 
00085 #endif
00086 
00087 

Comments?