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

# PropertyValueCollection.h

Go to the documentation of this file.

    00001 #ifndef _PROPERTYVALUECOLLECTION_H_
    00002 #define _PROPERTYVALUECOLLECTION_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/PropertyValue.h>
    00028 #include <Fdo/Commands/CommandException.h>
    00029
    00030 /// \brief
    00031 /// FdoPropertyValueCollection represents a collection of property values. Property
    00032 /// values are name/value pairs used for specifying the values of properties for
    00033 /// insert and update commands.
    00034 class FdoPropertyValueCollection : public FdoCollection<FdoPropertyValue, FdoCommandException>
    00035 {
    00036 /// \cond DOXYGEN-IGNORE
    00037 protected:
    00038     /// Constructs a default empty instance of an FdoPropertyValueCollection.
    00039     FdoPropertyValueCollection():FdoCollection<FdoPropertyValue, FdoCommandException>()
    00040     {
    00041     }
    00042
    00043     virtual ~FdoPropertyValueCollection()
    00044     {
    00045     }
    00046
    00047     virtual void Dispose()
    00048     {
    00049         delete this;
    00050     }
    00051 /// \endcond
    00052
    00053 public:
    00054     /// \brief
    00055     /// Constructs a default empty instance of an FdoPropertyValueCollection.
    00056     ///
    00057     /// \return
    00058     /// Returns FdoPropertyValueCollection
    00059     ///
    00060     FDO_API static FdoPropertyValueCollection* Create();
    00061
    00062     /// \brief
    00063     /// Gets the item in the collection with the specified name. Throws an invalid
    00064     /// argument exception if an item with the specified name does not exist in
    00065     /// the collection.
    00066     ///
    00067     /// \param name
    00068     /// Input name of item
    00069     ///
    00070     /// \return
    00071     /// Returns FdoPropertyValue
    00072     ///
    00073     FDO_API FdoPropertyValue* GetItem(FdoString* name);
    00074
    00075     /// \brief
    00076     /// Finds the item in the collection with the specified name. Returns NULL
    00077     /// if an item with the specified name does not exist in the collection.
    00078     ///
    00079     /// \param name
    00080     /// Input name of item
    00081     ///
    00082     /// \return
    00083     /// Returns FdoPropertyValue
    00084     ///
    00085     FDO_API FdoPropertyValue* FindItem(FdoString* name);
    00086
    00087     /// \brief
    00088     /// Gets the item in the collection at the specified index. Throws an
    00089     /// invalid argument exception if the index is out of range.
    00090     ///
    00091     /// \param index
    00092     /// Input index of item
    00093     ///
    00094     /// \return
    00095     /// Returns FdoPropertyValue
    00096     ///
    00097     FDO_API FdoPropertyValue* GetItem(FdoInt32 index);
    00098 };
    00099 #endif
    00100
    00101

Please send us your comment about this page