FDO API Reference Feature Data Objects

GeometricCondition.h

Go to the documentation of this file.
00001 #ifndef _GEOMETRICCONDITION_H_
00002 #define _GEOMETRICCONDITION_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 
00022 #ifdef _WIN32
00023 #pragma once
00024 #endif
00025 
00026 #include <FdoStd.h>
00027 #include <Fdo/Expression/Identifier.h>
00028 #include <Fdo/Filter/SearchCondition.h>
00029 
00030 /// \brief
00031 /// The FdoGeometricCondition abstract class derives from FdoSearchCondition and can
00032 /// be used to test whether the value of a geometric property meets a particular
00033 /// spatial criteria. FdoGeometricCondition is the base class for FdoDistanceCondition
00034 /// and FdoSpatialCondition.
00035 class FdoGeometricCondition : public FdoSearchCondition
00036 {
00037 protected:
00038 /// \cond DOXYGEN-IGNORE
00039     /// Constructs a default instance of an FdoGeometricCondition.
00040     FdoGeometricCondition();
00041 
00042     /// Constructs an instance of an FdoGeometricCondition using the specified
00043     /// arguments.
00044     FdoGeometricCondition(FdoString* propertyName);
00045 
00046     /// Constructs an instance of an FdoGeometricCondition using the specified
00047     /// arguments.
00048     FdoGeometricCondition(FdoIdentifier* propertyName);
00049 
00050     virtual ~FdoGeometricCondition();
00051 /// \endcond
00052 
00053 public:
00054     /// \brief
00055     /// Gets the name of the geometric property.
00056     /// 
00057     /// \return
00058     /// Returns the name of the geometric property
00059     /// 
00060     FDO_API FdoIdentifier* GetPropertyName();
00061 
00062     /// \brief
00063     /// Sets the name of the geometric property.
00064     /// 
00065     /// \param value 
00066     /// Input the name of the geometric property
00067     /// 
00068     /// \return
00069     /// Returns nothing
00070     /// 
00071     FDO_API void SetPropertyName(FdoIdentifier* value);
00072 
00073 private:
00074     FdoIdentifier*  m_geometricPropertyName;
00075 };
00076 #endif
00077 
00078 

Comments or suggestions? Send us feedback.