FDO .NET API Reference

Feature Data Objects

mgDictionary.h

Go to the documentation of this file.

/*
* Copyright (C) 2004-2006  Autodesk, Inc.
* 
* This library is free software; you can redistribute it and/or
* modify it under the terms of version 2.1 of the GNU Lesser
* General Public License as published by the Free Software Foundation.
* 
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
* Lesser General Public License for more details.
* 
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*
*/

#pragma once

#include <Runtime\Disposable.h>

class FdoDictionary;

BEGIN_NAMESPACE_OSGEO_COMMON
public __gc class DictionaryElement;

/// \ingroup (OSGeoFDOCommon)
/// \brief
/// DictionaryElementCollection is a collection of DictionaryElement objects(name-value pairs).
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class DictionaryElementCollection : 
    public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
/// \cond DOXYGEN-IGNORE
private:
    /// \brief
    ///     A Nested class defined to provide enumeration of Dictionary elements
    ///
    ///     Enumerators can be used to read the data in the collection, 
    ///     but they cannot be used to modify the underlying collection.
    ///
    ///     An enumerator remains valid as long as the collection remains unchanged. 
    ///     If changes are made to the collection, such as adding, modifying, or deleting 
    ///     elements, the enumerator is irrecoverably invalidated and the next call to 
    ///     MoveNext or Reset throws an InvalidOperationException. If the collection is 
    ///     modified between MoveNext and Current, Current returns the element that it is 
    ///     set to, even if the enumerator is already invalidated.
    ///
    ///     The enumerator does not have exclusive access to the collection; therefore, 
    ///     enumerating through a collection is intrinsically not a thread-safe procedure. 
    ///     Even when a collection is synchronized, other threads can still modify the 
    ///     collection, which causes the enumerator to throw an exception. To guarantee 
    ///     thread safety during enumeration, you can either lock the collection during 
    ///     the entire enumeration or catch the exceptions resulting from changes made 
    ///     by other threads.
    /// 
    __gc class Enumerator : public System::Collections::IEnumerator 
    {
    private:
        DictionaryElementCollection* m_pCol;
        System::Int32 m_nIdx;

    public:
        /// \brief
        ///     Constructs a new dictionary Enumerator
        /// 
        /// \param elements 
        ///     Input The Dictionary collection to enumerate.
        /// 
        Enumerator(DictionaryElementCollection* elements) : m_pCol(elements), m_nIdx(-1) 
        {
        }

        /// \brief
        ///     Retrieves the current dictionay element at the enumerator location
        /// 
        /// \return
        ///     Retuns the current dictionary element referenced by the enumerator
        /// 
        __property System::Object* get_Current();
        
        /// \brief
        ///     Initially, the enumerator is positioned before the first element in the collection. 
        ///     At this position, calling the Current property throws an exception. 
        ///     Therefore, you must call the MoveNext method to advance the enumerator 
        ///     to the first element of the collection before reading the value of Current.
        //      If MoveNext passes the end of the collection, the enumerator is positioned 
        ///     after the last element in the collection and MoveNext returns false. 
        ///     When the enumerator is at this position, subsequent calls to MoveNext also return false. 
        ///     If the last call to MoveNext returned false, calling Current throws an exception. 
        //      To set Current to the first element of the collection again, you can call Reset 
        ///     followed by MoveNext.
        /// 
        /// \return
        ///     Retuns true if the enumerator is able to move to a valid dictionary element
        ///     otherwise false.
        /// 
        System::Boolean MoveNext();
        
        /// \brief
        ///     Initially, the enumerator is positioned before the first element in the collection. 
        ///     The Reset method brings the enumerator back to this position. 
        /// 
        System::Void Reset();
    };

public private:
    inline FdoDictionary* GetImpObj();

private:
    // System::Collections::ICollection interface properties
    __property System::Object* System::Collections::ICollection::get_SyncRoot();
    __property System::Boolean System::Collections::ICollection::get_IsSynchronized();

    // System::Collections::ICollection interface methods
    System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);

    // System::Collections::IList interface properties
    __property System::Boolean System::Collections::IList::get_IsFixedSize();
    __property System::Boolean System::Collections::IList::get_IsReadOnly();
    __property Object* System::Collections::IList::get_Item(System::Int32 index);
    __property System::Void  System::Collections::IList::set_Item(System::Int32 index, Object* value);

    // System::Collections::IList interface methods
    System::Int32 System::Collections::IList::Add(Object* value);
    System::Boolean System::Collections::IList::Contains(Object* value);
    System::Int32 System::Collections::IList::IndexOf(Object* value);
    System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
    System::Void System::Collections::IList::Remove(Object* value);

/// \endcond

public:
    /// \brief
    ///     Constructs a new empty dictionary element collection
    /// 
    DictionaryElementCollection();

    /// \brief
    ///     Constructs a dictionary object based on an unmanaged instance of the object
    /// 
    /// \param unmanaged 
    ///     Input A Pointer to the unmanaged collection.
    /// 
    /// \param autoDelete 
    ///     Input Indicates if the constructed object should be automatically deleted 
    ///     once it no longer referenced.
    /// 
    DictionaryElementCollection(System::IntPtr unmanaged, System::Boolean autoDelete);

    /// \brief
    ///    Gets the count of items in collection.
    /// 
    /// \return
    ///     Returns the number of items in the collection.
    /// 
    __property System::Int32 get_Count(System::Void);

    /// \brief
    ///    Gets an enumerator that can iterate through a collection.
    /// 
    /// \return
    ///     Returns an enumerator on the dictionary.
    /// 
    __sealed System::Collections::IEnumerator* GetEnumerator(System::Void);

    /// \brief
    ///     Removes the index-th DictionaryElement from this collection.
    /// 
    /// \param index 
    ///     Input index of the element to remove.
    /// 
    System::Void RemoveAt(System::Int32 index);

    /// \brief
    ///     Removes all elements from the collection.
    /// 
    System::Void  Clear();

    /// \brief
    ///     Adds a DictionaryElement object into the collection.
    /// 
    /// \param value 
    ///     Input the DictionaryElement object to add.
    /// 
    /// \return
    ///     Returns the position into which the new element was inserted.
    /// 
    System::Int32 Add(DictionaryElement* value);

    /// \brief
    ///     Determines the index of a specific DictionaryElement object.
    /// 
    /// \param value 
    ///     Input the DictionaryElement object to locate in the collection.
    /// 
    /// \return
    ///     The index of value if found in the collection; otherwise, -1.
    /// 
    System::Int32 IndexOf(DictionaryElement* value);
    
    /// \brief
    ///     Determines the index of a specific DictionaryElement object.
    /// 
    /// \param name 
    ///     Input the name of the DictionaryElement object to locate in the collection.
    /// 
    /// \return
    ///     The index of value if found in the collection; otherwise, -1.
    /// 
    System::Int32 IndexOf(String* name);

    /// \brief
    ///     Inserts a DictionaryElement object into the collection at the specified position.
    /// 
    /// \param index 
    ///     Input the zero-based index at which value should be inserted.
    ///
    /// \param value 
    ///     Input the DictionaryElement object to insert.
    /// 
    System::Void Insert(System::Int32 index, DictionaryElement* value);

    /// \brief
    ///     Removes the first occurrence of a specific DictionaryElement object.
    /// 
    /// \param value 
    ///     Input the DictionaryElement object to remove from the collection.
    /// 
    System::Void Remove(DictionaryElement* value);

    /// \brief
    ///     Determines whether the collection contains a specific DictionaryElement object.
    /// 
    /// \param value 
    ///     Input The DictionaryElement object to find in the collection.
    /// 
    /// \return
    ///     Returns true if the value is found in the collection; otherwise, false.
    /// 
    System::Boolean Contains(DictionaryElement* value);

    /// \brief
    ///     Determines whether the collection contains a specific DictionaryElement object.
    /// 
    /// \param name 
    ///     Input The name of the DictionaryElement object to find in the collection.
    /// 
    /// \return
    ///     Returns true if the value is found in the collection; otherwise, false.
    /// 
    System::Boolean Contains(String* name);

    /// \brief
    ///     Copies the elements of the collection to an array.
    /// 
    /// \param array 
    ///     Output the one-dimensional Array that is the destination of the elements copied from this collection.
    ///
    /// \param index 
    ///     Input an integer that represents the index in array at which copying begins.
    /// 
    System::Void CopyTo(DictionaryElement* array[],System::Int32 index);

    /// \brief
    ///     Gets a DictionaryElement in the collection.
    /// 
    /// \param index 
    ///     Input index of the DictionaryElement to retrieve.
    /// 
    /// \return
    ///     Returns the requested dictionary element.
    /// 
    __property DictionaryElement* get_RealTypeItem(System::Int32 index);

    /// \brief
    ///     Gets a named DictionaryElement in the collection.
    /// 
    /// \param index 
    ///     Input name of the DictionaryElement to retrieve.
    /// 
    /// \return
    ///     Returns the requested dictionary element.
    /// 
    __property DictionaryElement* get_RealTypeItem(System::String* index);

    /// \brief
    ///     Sets a DictionaryElement in the collection.
    /// 
    /// \param index 
    ///     Input The index of the DictionaryElement to set.
    /// 
    /// \param value
    ///     The dictionary element to set at the specified index
    /// 
    __property System::Void  set_RealTypeItem(System::Int32 index, DictionaryElement* value);

    /// \brief
    ///     Gets a DictionaryElement in the collection.
    /// 
    /// \param index 
    ///     Input index of the DictionaryElement to retrieve.
    /// 
    /// \return
    ///     Returns the requested dictionary element.
    /// 
    __property DictionaryElement* get_Item(System::Int32 index);

    /// \brief
    ///     Sets a DictionaryElement in the collection.
    /// 
    /// \param index 
    ///     Input The index of the DictionaryElement to set.
    /// 
    /// \param value
    ///     The dictionary element to set at the specified index
    /// 
    __property System::Void  set_Item(System::Int32 index, DictionaryElement* value);

/// \cond DOXYGEN-IGNORE
protected:
    System::Void ReleaseUnmanagedObject();
/// \endcond
};

END_NAMESPACE_OSGEO_COMMON

---

Comments or suggestions? Send us feedback.