- Main Page
- Related Pages
- Modules
- Classes
- Files

# ParameterValueCollection.h

Go to the documentation of this file.

    00001 #ifndef _PARAMETERVALUECOLLECTION_H_
    00002 #define _PARAMETERVALUECOLLECTION_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/Commands/ParameterValue.h>
    00028 #include <Fdo/Commands/CommandException.h>
    00029
    00030 /// \brief
    00031 /// The FdoParameterValueCollection class represents a collection of FdoParameterValue objects.
    00032 class FdoParameterValueCollection : public FdoCollection<FdoParameterValue, FdoCommandException>
    00033 {
    00034 protected:
    00035 /// \cond DOXYGEN-IGNORE
    00036     virtual void Dispose();
    00037 /// \endcond
    00038
    00039 public:
    00040     /// \brief
    00041     /// Constructs a default empty instance of an FdoParameterValueCollection.
    00042     ///
    00043     /// \return
    00044     /// Returns FdoParameterValueCollection
    00045     ///
    00046     FDO_API static FdoParameterValueCollection* Create();
    00047
    00048     /// \brief
    00049     /// Gets the item in the collection with the specified name. Throws an
    00050     /// invalid argument exception if an item with the specified name does not
    00051     /// exist in the collection.
    00052     ///
    00053     /// \param name
    00054     /// Input name
    00055     ///
    00056     /// \return
    00057     /// Returns FdoParameterValue
    00058     ///
    00059     FDO_API FdoParameterValue* GetItem(FdoString* name);
    00060
    00061     /// \brief
    00062     /// Gets the item in the collection with the specified name. Returns
    00063     /// NULL if an item with the specified name does not exist in the collection.
    00064     ///
    00065     /// \param name
    00066     /// Input name
    00067     ///
    00068     /// \return
    00069     /// Returns FdoParameterValue
    00070     ///
    00071     FDO_API FdoParameterValue* FindItem(FdoString* name);
    00072
    00073     /// \brief
    00074     /// Gets the item in the collection at the specified index. Throws an
    00075     /// invalid argument exception if the index is out of range.
    00076     ///
    00077     /// \param index
    00078     /// Input index
    00079     ///
    00080     /// \return
    00081     /// Returns FdoParameterValue
    00082     ///
    00083     FDO_API FdoParameterValue* GetItem(FdoInt32 index);
    00084 };
    00085 #endif
    00086
    00087

Please send us your comment about this page