FDO .NET API Reference Feature Data Objects

mgBinaryLogicalOperator.h

Go to the documentation of this file.
00001 /*
00002 * Copyright (C) 2004-2006  Autodesk, Inc.
00003 * 
00004 * This library is free software; you can redistribute it and/or
00005 * modify it under the terms of version 2.1 of the GNU Lesser
00006 * General Public License as published by the Free Software Foundation.
00007 * 
00008 * This library is distributed in the hope that it will be useful,
00009 * but WITHOUT ANY WARRANTY; without even the implied warranty of
00010 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00011 * Lesser General Public License for more details.
00012 * 
00013 * You should have received a copy of the GNU Lesser General Public
00014 * License along with this library; if not, write to the Free Software
00015 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00016 *
00017 */
00018 
00019 #pragma once
00020 
00021 #include "FDO\Filter\mgLogicalOperator.h"
00022 #include "FDO\Filter\mgBinaryLogicalOperations.h"
00023 
00024 class FdoBinaryLogicalOperator;
00025 
00026 BEGIN_NAMESPACE_OSGEO_FDO_FILTER
00027 public __gc class Filter;
00028 public __gc __interface IFilterProcessor;
00029 
00030 /// \ingroup (OSGeoFDOFilter)
00031 /// \brief
00032 /// The BinaryLogicalOperator class derives from LogicalOperator and allows two
00033 /// filters to be combined via a logical "and" or a logical "or".
00034 public __gc class BinaryLogicalOperator : public NAMESPACE_OSGEO_FDO_FILTER::LogicalOperator
00035 {
00036 public:
00037     /// \brief
00038     /// Constructs a default instance of an BinaryLogicalOperator.
00039     /// 
00040     /// \return
00041     /// Returns BinaryLogicalOperator
00042     /// 
00043     BinaryLogicalOperator();
00044 
00045     /// \brief
00046     /// Constructs an instance of an BinaryLogicalOperator using the specified arguments.
00047     /// 
00048     /// \param leftOperand 
00049     /// Input left hand operand
00050     /// \param operation 
00051     /// Input operator
00052     /// \param rightOperand 
00053     /// Input right hand operand
00054     /// 
00055     /// \return
00056     /// Returns BinaryLogicalOperator
00057     /// 
00058     BinaryLogicalOperator(NAMESPACE_OSGEO_FDO_FILTER::Filter* leftOperand, NAMESPACE_OSGEO_FDO_FILTER::BinaryLogicalOperations operation, NAMESPACE_OSGEO_FDO_FILTER::Filter* rightOperand);
00059 
00060     /// \brief
00061     /// Gets the operation to be performed between the two operands.
00062     /// 
00063     /// \return
00064     /// Returns the operation to be performed
00065     /// 
00066     __property NAMESPACE_OSGEO_FDO_FILTER::BinaryLogicalOperations get_Operation();
00067 
00068     /// \brief
00069     /// Sets the operation to be performed between the two operands.
00070     /// 
00071     /// \param value 
00072     /// Input the operation to be performed
00073     /// 
00074     /// \return
00075     /// Returns nothing
00076     /// 
00077     __property System::Void set_Operation(NAMESPACE_OSGEO_FDO_FILTER::BinaryLogicalOperations value);
00078 
00079     /// \brief
00080     /// Gets the filter that defines the left operand.
00081     /// 
00082     /// \return
00083     /// Returns the filter that defines the left operand
00084     /// 
00085     __property NAMESPACE_OSGEO_FDO_FILTER::Filter* get_LeftOperand();
00086 
00087     /// \brief
00088     /// Sets the filter that defines the left operand.
00089     /// 
00090     /// \param value 
00091     /// Input the filter that defines the left operand
00092     /// 
00093     /// \return
00094     /// Returns nothing
00095     /// 
00096     __property System::Void set_LeftOperand(NAMESPACE_OSGEO_FDO_FILTER::Filter* value);
00097 
00098     /// \brief
00099     /// Gets the filter that defines the right operand.
00100     /// 
00101     /// \return
00102     /// Returns the filter that defines the right operand
00103     /// 
00104     __property NAMESPACE_OSGEO_FDO_FILTER::Filter* get_RightOperand();
00105 
00106     /// \brief
00107     /// Sets the filter that defines the right operand.
00108     /// 
00109     /// \param value 
00110     /// Input the filter that defines the right operand
00111     /// 
00112     /// \return
00113     /// Returns nothing
00114     /// 
00115     __property System::Void set_RightOperand(NAMESPACE_OSGEO_FDO_FILTER::Filter* value);
00116 
00117     /// \brief
00118     /// Overrides Filter.Process to pass BinaryLogicalOperator to the
00119     /// appropriate filter processor operation.
00120     /// 
00121     /// \param processor 
00122     /// Input filter processor
00123     /// 
00124     /// \return
00125     /// Returns nothing
00126     /// 
00127     System::Void Process(NAMESPACE_OSGEO_FDO_FILTER::IFilterProcessor* processor);
00128 
00129     /// \brief
00130     /// Constructs a BinaryLogicalOperator object based on an unmanaged instance of the object
00131     /// 
00132     /// \param unmanaged 
00133     /// Input A Pointer to the unmanaged object.
00134     /// 
00135     /// \param autoDelete 
00136     /// Input Indicates if the constructed object should be automatically deleted 
00137     /// once it no longer referenced.
00138     /// 
00139     BinaryLogicalOperator(System::IntPtr unmanaged, System::Boolean autoDelete);
00140 
00141 public private:
00142     inline FdoBinaryLogicalOperator* GetImpObj();
00143 };
00144 
00145 END_NAMESPACE_OSGEO_FDO_FILTER
00146 
00147 

Comments or suggestions? Send us feedback.