FDO API Reference Feature Data Objects

ConditionType.h

Go to the documentation of this file.
00001 #ifndef _CONDITIONTYPE_H_
00002 #define _CONDITIONTYPE_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 /// \brief
00027 /// The FdoConditionType enumeration defines the filter condition types available. 
00028 /// This enumeration is used in the capabilities.
00029 /// <param name="FdoConditionType_Comparison">
00030 /// Tests if one expression is equal, not equal, greater than, less than, 
00031 /// greater than or equal to, or less than or equal to another expression
00032 /// </param>
00033 /// <param name="FdoConditionType_Like">
00034 /// Tests if the value of a specified data property matches a specified pattern
00035 /// </param>
00036 /// <param name="FdoConditionType_In">
00037 /// Tests if the value of a specified data property is within a given set 
00038 /// of literal values
00039 /// </param>
00040 /// <param name="FdoConditionType_Null">
00041 /// Tests if the value of a specified data property is null
00042 /// </param>
00043 /// <param name="FdoConditionType_Spatial">
00044 /// Tests whether the value of a geometric property and a literal geometric 
00045 /// value satisfy the spatial relationship implied by the operation
00046 /// </param>
00047 /// <param name="FdoConditionType_Distance">
00048 /// Tests whether the value of a geometric property is within or beyond a 
00049 /// specified distance of a literal geometric value
00050 /// </param>
00051 enum FdoConditionType
00052 {
00053     /// Tests if one expression is equal, not equal, greater than, less than, 
00054     /// greater than or equal to, or less than or equal to another expression.
00055     FdoConditionType_Comparison,
00056 
00057     /// Tests if the value of a specified data property is matches a specified pattern.
00058     FdoConditionType_Like,
00059 
00060     /// Tests if the value of a specified data property is within a given set 
00061     /// of literal values.
00062     FdoConditionType_In,
00063 
00064     /// Tests if the value of a specified data property is null.
00065     FdoConditionType_Null,
00066 
00067     /// Tests whether the value of a geometric property and a literal geometric 
00068     /// value satisfy the spatial relationship implied by the operation.
00069     FdoConditionType_Spatial,
00070 
00071     /// Tests whether the value of a geometric property is within or beyond a 
00072     /// specified distance of a literal geometric value.
00073     FdoConditionType_Distance
00074 };
00075 #endif
00076 
00077 

Comments or suggestions? Send us feedback.