FDO .NET API Reference Feature Data Objects

mgIFeatureCommandImp.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\Commands\mgIFeatureCommand.h"
00022 #include "FDO\Commands\mgICommandImp.h"
00023 
00024 class FdoIFeatureCommand;
00025 
00026 BEGIN_NAMESPACE_OSGEO_FDO_EXPRESSION
00027 public __gc class Identifier;
00028 END_NAMESPACE_OSGEO_FDO_EXPRESSION
00029 
00030 BEGIN_NAMESPACE_OSGEO_FDO_FILTER
00031 public __gc class Filter;
00032 END_NAMESPACE_OSGEO_FDO_FILTER
00033 
00034 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS
00035 
00036 /// \ingroup (OSGeoFDOCommands)
00037 /// \brief
00038 /// The IFeatureCommandImp class is a concrete implementation of IFeatureCommand.
00039 /// IFeatureCommand defines the behavior common to all commands that operate on feature instances. 
00040 /// The features to be operated on are identified by their class and a filter. 
00041 /// If the feature provider supports inheritance in the schema capabilities, then the command 
00042 /// will operate on instances of that class and any derived classes. 
00043 /// In addition, feature commands can operate on related features if one or 
00044 /// more relation directives are specified. Each relation directive specifies 
00045 /// the relation to follow and how many levels of depth to follow it.
00046 private __gc class IFeatureCommandImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, 
00047                                         public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommand
00048 {
00049 public:
00050     /// \brief
00051     /// Gets the name of the class to be operated upon as an identifier.
00052     /// 
00053     /// \return
00054     /// Returns nothing
00055     /// 
00056     __property NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* get_FeatureClassName();
00057 
00058     /// \brief
00059     /// Sets the name of the class to be operated upon as an identifier.
00060     /// 
00061     /// \param value 
00062     /// Input the class identifier
00063     /// 
00064     /// \return
00065     /// Returns nothing
00066     /// 
00067     __property System::Void set_FeatureClassName(NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* value);
00068 
00069     /// \brief
00070     /// Sets the name of the class to be operated upon as an identifier.
00071     /// 
00072     /// \param value 
00073     /// Input the class name
00074     /// 
00075     /// \return
00076     /// Returns nothing
00077     /// 
00078     System::Void SetFeatureClassName(System::String* value);
00079 
00080     /// \brief
00081     /// Gets the filter as a filter tree.
00082     /// 
00083     /// \return
00084     /// Returns the filter object
00085     /// 
00086     __property NAMESPACE_OSGEO_FDO_FILTER::Filter* get_Filter();
00087 
00088     /// \brief
00089     /// Sets the filter as a Filter tree.
00090     /// 
00091     /// \param value 
00092     /// Input the filter object
00093     /// 
00094     /// \return
00095     /// Returns nothing
00096     /// 
00097     __property System::Void set_Filter(NAMESPACE_OSGEO_FDO_FILTER::Filter* value);
00098 
00099     /// \brief
00100     /// Sets the filter as a Filter tree.
00101     /// 
00102     /// \param value 
00103     /// Input the filter expression string
00104     /// 
00105     /// \return
00106     /// Returns nothing
00107     /// 
00108     System::Void SetFilter(System::String* value);
00109 
00110 public private:
00111     IFeatureCommandImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp(unmanaged, autoDelete)
00112     {
00113 
00114     }
00115 
00116     inline FdoIFeatureCommand* GetImpObj();
00117 };
00118 
00119 END_NAMESPACE_OSGEO_FDO_COMMANDS
00120 
00121 

Comments or suggestions? Send us feedback.