FDO API Reference Feature Data Objects

FunctionDefinitionCollection.h

Go to the documentation of this file.
00001 #ifndef _FUNCTIONDEFINITIONCOLLECTION_H_
00002 #define _FUNCTIONDEFINITIONCOLLECTION_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 #include <FdoStd.h>
00027 #include <Fdo/Connections/Capabilities/FunctionDefinition.h>
00028 #include <Fdo/Connections/ConnectionException.h>
00029 
00030 /// \brief
00031 /// The FdoFunctionDefinitionCollection class represents a collection of FdoFunctionDefinition objects.
00032 class FdoFunctionDefinitionCollection : public FdoNamedCollection<FdoFunctionDefinition, FdoConnectionException>
00033 {
00034 protected:
00035     virtual void Dispose();
00036 
00037 public:
00038     /// \brief
00039     /// Constructs a default empty instance of an FdoFunctionDefinitionCollection.
00040     /// 
00041     /// \return
00042     /// Returns FdoFunctionDefinitionCollection
00043     /// 
00044     FDO_API static FdoFunctionDefinitionCollection* Create();
00045 
00046     /// \brief
00047     /// Constructs an instance of an FdoFunctionDefinitionCollection from an array of 
00048     /// FdoFunctionDefinition objects.
00049     /// 
00050     /// \param arguments 
00051     /// Input an array of FdoFunctionDefinition objects
00052     /// \param length 
00053     /// Input the number of arguments
00054     /// 
00055     /// \return
00056     /// Returns FdoFunctionDefinitionCollection
00057     /// 
00058     FDO_API static FdoFunctionDefinitionCollection* Create(FdoFunctionDefinition** arguments, FdoInt32 length);
00059 };
00060 #endif
00061 
00062 

Comments or suggestions? Send us feedback.