FDO API Reference | Feature Data Objects |
00001 #ifndef _NULLCONDITION_H_ 00002 #define _NULLCONDITION_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 FdoNullCondition class derives from FdoSearchCondition and can be used to test 00032 /// if the value of a specified data property is null. 00033 class FdoNullCondition : public FdoSearchCondition 00034 { 00035 protected: 00036 /// \cond DOXYGEN-IGNORE 00037 /// Constructs a default instance of an FdoNullCondition. 00038 FdoNullCondition(); 00039 00040 /// Constructs an instance of an FdoNullCondition using the specified arguments. 00041 FdoNullCondition(FdoString* propertyName); 00042 00043 /// Constructs an instance of an FdoNullCondition using the specified arguments. 00044 FdoNullCondition(FdoIdentifier* propertyName); 00045 00046 virtual ~FdoNullCondition(); 00047 00048 virtual void Dispose(); 00049 /// \endcond 00050 00051 public: 00052 /// \brief 00053 /// Constructs a default instance of an FdoNullCondition. 00054 /// 00055 /// \return 00056 /// Returns an FdoNullCondition 00057 /// 00058 FDO_API static FdoNullCondition* Create(); 00059 00060 /// \brief 00061 /// Constructs an instance of an FdoNullCondition using the specified arguments. 00062 /// 00063 /// \param propertyName 00064 /// Input name 00065 /// 00066 /// \return 00067 /// Returns an FdoNullCondition 00068 /// 00069 FDO_API static FdoNullCondition* Create(FdoString* propertyName); 00070 00071 /// \brief 00072 /// Constructs an instance of an FdoNullCondition using the specified arguments. 00073 /// 00074 /// \param propertyName 00075 /// Input name 00076 /// 00077 /// \return 00078 /// Returns an FdoNullCondition 00079 /// 00080 FDO_API static FdoNullCondition* Create(FdoIdentifier* propertyName); 00081 00082 /// \brief 00083 /// Gets the name of the data property. 00084 /// 00085 /// \return 00086 /// Returns FdoIdentifier 00087 /// 00088 FDO_API FdoIdentifier* GetPropertyName(); 00089 00090 /// \brief 00091 /// Sets the name of the data property. 00092 /// 00093 /// \param value 00094 /// Input name 00095 /// 00096 /// \return 00097 /// Returns nothing 00098 /// 00099 FDO_API void SetPropertyName(FdoIdentifier* value); 00100 00101 /// \brief 00102 /// Overrides FdoFilter.Process to pass the FdoNullCondition to the 00103 /// appropriate filter processor operation. 00104 /// 00105 /// \param p 00106 /// Input filter processor 00107 /// 00108 /// \return 00109 /// Returns nothing 00110 /// 00111 FDO_API void Process(FdoIFilterProcessor* p); 00112 00113 /// \cond DOXYGEN-IGNORE 00114 /// \brief 00115 /// This is an internal method. It returns the well defined text representation of the filter. 00116 /// 00117 /// \param pIdCol 00118 /// A identifier collection that contains all the computed identifier used by the filter 00119 /// 00120 /// \return 00121 /// Returns the well defined text string 00122 /// 00123 FdoString* ToStringInternal( FdoIdentifierCollection *pIdCol ); 00124 /// \endcond 00125 00126 private: 00127 FdoIdentifier* m_propertyName; 00128 }; 00129 #endif 00130 00131
Comments or suggestions? Send us feedback. |