FDO .NET API Reference Feature Data Objects

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

Comments or suggestions? Send us feedback.