FDO API Reference Feature Data Objects

ComparisonOperations.h

Go to the documentation of this file.
00001 #ifndef _COMPARISONOPERATIONS_H_
00002 #define _COMPARISONOPERATIONS_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 FdoComparisonOperations enumeration lists the comparison operations
00028 /// available.
00029 /// <param name="FdoComparisonOperations_EqualTo">
00030 /// Test to see if the left and right expressions are equal
00031 /// </param>
00032 /// <param name="FdoComparisonOperations_NotEqualTo">
00033 /// Test to see if the left and right expressions are not equal
00034 /// </param>
00035 /// <param name="FdoComparisonOperations_GreaterThan">
00036 /// Test to see if the left expression is greater than the right expression
00037 /// </param>
00038 /// <param name="FdoComparisonOperations_GreaterThanOrEqualTo">
00039 /// Test to see if the left expression is greater than or equal to the right expression
00040 /// </param>
00041 /// <param name="FdoComparisonOperations_LessThan">
00042 /// Test to see if the left expression is less than the right expression
00043 /// </param>
00044 /// <param name="FdoComparisonOperations_LessThanOrEqualTo">
00045 /// Test to see if the left expression is less than or equal to the right expression
00046 /// </param>
00047 /// <param name="FdoComparisonOperations_Like">
00048 /// Test to see if the left expression matches the pattern specified by the
00049 /// right expression.  Wildcard characters supported in the pattern are:
00050 ///
00051 /// %    Any string of zero or more characters;
00052 /// _    Any single character;
00053 /// []   Any single character within the specified range ([a-f]) or set 
00054 /// ([abcdef]);
00055 /// [^]  Any single character not within the specified range ([^a-f]) or 
00056 /// set ([^abcdef]).
00057 /// </param>
00058 enum FdoComparisonOperations
00059 {
00060     /// Test to see if the left and right expressions are equal.
00061     FdoComparisonOperations_EqualTo,
00062 
00063     /// Test to see if the left and right expressions are not equal.
00064     FdoComparisonOperations_NotEqualTo,
00065 
00066     /// Test to see if the left expression is greater than the right expression.
00067     FdoComparisonOperations_GreaterThan,
00068 
00069     /// Test to see if the left expression is greater than or equal to the right expression.
00070     FdoComparisonOperations_GreaterThanOrEqualTo,
00071 
00072     /// Test to see if the left expression is less than the right expression.
00073     FdoComparisonOperations_LessThan,
00074 
00075     /// Test to see if the left expression is less than or equal to the right expression.
00076     FdoComparisonOperations_LessThanOrEqualTo,
00077 
00078     /// Test to see if the left expression matches the pattern specified by the
00079     /// right expression.  Wildcard characters supported in the pattern are:
00080     //
00081     /// %    Any string of zero or more characters
00082     /// _    Any single character
00083     /// []   Any single character within the specified range ([a-f]) or set 
00084     /// ([abcdef]).
00085     /// [^]  Any single character not within the specified range ([^a-f]) or 
00086     /// set ([^abcdef]).
00087     FdoComparisonOperations_Like
00088 };
00089 #endif
00090 
00091 

Comments or suggestions? Send us feedback.