| FDO API Reference | Feature Data Objects |
00001 #ifndef _INT32VALUE_H_ 00002 #define _INT32VALUE_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/DataValue.h> 00028 #include <Fdo/Schema/DataType.h> 00029 00030 /// \brief 00031 /// The FdoInt32Value class derives from FdoDataValue and represents a 32-bit signed integer value. 00032 class FdoInt32Value : public FdoDataValue 00033 { 00034 protected: 00035 /// \cond DOXYGEN-IGNORE 00036 /// \brief 00037 /// Constructs a default instance of an FdoInt32Value with a 00038 /// value of null. 00039 /// \return 00040 /// Returns nothing 00041 /// 00042 FdoInt32Value(); 00043 00044 /// \brief 00045 /// Constructs a default instance of an FdoInt32Value using the specified arguments. 00046 /// \param value 00047 /// Input a 32 bit integer 00048 /// 00049 /// \return 00050 /// Returns nothing 00051 /// 00052 FdoInt32Value(FdoInt32 value); 00053 00054 /// \brief 00055 /// Default destructor for FdoInt32Value. 00056 /// \return 00057 /// Returns nothing 00058 /// 00059 virtual ~FdoInt32Value(); 00060 00061 virtual void Dispose(); 00062 /// \endcond 00063 00064 public: 00065 /// \brief 00066 /// Constructs a default instance of an FdoInt32Value with a value of null. 00067 /// 00068 /// \return 00069 /// Returns nothing 00070 /// 00071 FDO_API static FdoInt32Value* Create(); 00072 00073 /// \brief 00074 /// Constructs a default instance of an FdoInt32Value using the specified arguments. 00075 /// 00076 /// \param value 00077 /// Input a 32 bit integer 00078 /// 00079 /// \return 00080 /// Returns nothing 00081 /// 00082 FDO_API static FdoInt32Value* Create(FdoInt32 value); 00083 00084 /// \brief 00085 /// Gets the data type of the FdoInt32Value. 00086 /// 00087 /// \return 00088 /// Returns an FdoDataType 00089 /// 00090 FDO_API FdoDataType GetDataType(); 00091 00092 /// \brief 00093 /// Gets the FdoInt32Value. 00094 /// 00095 /// \return 00096 /// Returns a 32 bit integer 00097 /// 00098 FDO_API FdoInt32 GetInt32(); 00099 00100 /// \brief 00101 /// Sets the FdoInt32Value. 00102 /// 00103 /// \param value 00104 /// Input a 32 bit integer 00105 /// 00106 /// \return 00107 /// Returns nothing 00108 /// 00109 FDO_API void SetInt32(FdoInt32 value); 00110 00111 /// \brief 00112 /// Overrides FdoExpression.Process to pass the FdoInt32Value to the appropriate 00113 /// expression processor operation. 00114 /// 00115 /// \param p 00116 /// Input an FdoIExpressionProcessor 00117 /// 00118 /// \return 00119 /// Returns nothing 00120 /// 00121 FDO_API void Process(FdoIExpressionProcessor* p); 00122 00123 /// \brief 00124 /// Returns the well defined text representation of this expression. 00125 /// 00126 /// \return 00127 /// Returns a character string 00128 /// 00129 FDO_API FdoString* ToString(); 00130 00131 /// \brief 00132 /// A cast operator to get the integer value. 00133 /// 00134 /// \return 00135 /// Returns a 32 bit integer 00136 /// 00137 FDO_API operator FdoInt32() 00138 { 00139 return m_data; 00140 } 00141 00142 protected: 00143 FdoInt32 m_data; 00144 }; 00145 #endif 00146 00147
| Comments or suggestions? Send us feedback. |