Changes between Version 16 and Version 17 of FDORfc17

Timestamp:

04/28/08 09:29:00 (17 years ago)

Author:

gregboone

Comment:

--

FDORfc17

@@ +1 @@
+
+{{{
+
+}}}
 = FDO RFC 17 - Add a Managed API for the FDO Expression Engine  =
 
@@ -287 +291 @@
 };
 }}}
+
+=== Expression Engine Function Collection ===
+
+{{{
+/// \brief
+/// The FunctionCollection class represents a collection of Expression Engine IFunction objects.
+///
+[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
+public __sealed __gc class FunctionCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
+{
+public:
+    /// \brief
+    /// Constructs a FunctionCollection object
+    /// 
+    /// \param parent 
+    /// Input A Pointer to the parent schema object of the collection
+    /// 
+    FunctionCollection(NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement* parent);
+
+    /// \brief
+    /// Constructs a FunctionCollection object based on an unmanaged instance of the object
+    /// 
+    /// \param unmanaged 
+    /// Input A Pointer to the unmanaged object.
+    /// 
+    /// \param autoDelete 
+    /// Input Indicates if the constructed object should be automatically deleted 
+    /// once it no longer referenced.
+    /// 
+    FunctionCollection(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, 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 OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction 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 IFunction object into the collection.
+    /// 
+    /// \param value 
+    /// Input the IFunction object to add.
+    /// 
+    /// \return
+    /// Returns the position into which the new element was inserted.
+    /// 
+    System::Int32 Add(OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* value);
+
+    /// \brief
+    /// Determines the index of a specific IFunction object.
+    /// 
+    /// \param value 
+    /// Input the IFunction object to locate in the collection.
+    /// 
+    /// \return
+    /// The index of value if found in the collection; otherwise, -1.
+    /// 
+    System::Int32 IndexOf(OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* value);
+
+    /// \brief
+    /// Determines the index of a specific IFunction object.
+    /// 
+    /// \param name 
+    /// Input the name of the 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 IFunction 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 IFunction object to insert.
+    /// 
+    System::Void Insert(System::Int32 index, OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* value);
+
+    /// \brief
+    /// Removes the first occurrence of a specific IFunction object.
+    /// 
+    /// \param value 
+    /// Input the IFunction object to remove from the collection.
+    /// 
+    System::Void Remove(OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* value);
+
+    /// \brief
+    /// Determines whether the collection contains a specific IFunction object.
+    /// 
+    /// \param value 
+    /// Input The IFunction object to search in the collection.
+    /// 
+    /// \return
+    /// Returns true if the value is found in the collection; otherwise, false.
+    /// 
+    System::Boolean Contains(OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* value);
+
+    /// \brief
+    /// Determines whether the collection contains a specific IFunction object.
+    /// 
+    /// \param name 
+    /// Input The name of the IFunction object to search 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 startAt 
+    /// Input an integer that represents the index in array at which copying begins.
+    /// 
+    System::Void CopyTo(OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* array[],System::Int32 startAt);
+
+    /// \brief
+    /// Gets the item in the collection at the specified index. 
+    /// 
+    /// \param index 
+    /// The index of the item in the collection. The index is 0 based.
+    /// 
+    /// \return
+    /// Returns an instance of a the collected item.
+    /// Throws an instance of Exception if the index is out of range or an error occurs.
+    /// 
+    __property OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* get_RealTypeItem(System::Int32 index);
+
+    /// \brief
+    /// Gets the item in the collection by name. 
+    /// 
+    /// \param index 
+    /// The name of the item in the collection.
+    /// 
+    /// \return
+    /// Returns an instance of a the collected item.
+    /// 
+    __property OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* get_RealTypeItem(System::String* index);
+
+    /// \brief
+    /// Sets the value of the item at the specified index
+    /// 
+    /// \param index 
+    /// Input index of the item to set.
+    /// 
+    /// \param value 
+    /// Input the value of the item
+    /// 
+    __property System::Void  set_RealTypeItem(System::Int32 index, OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* value);
+
+    /// \brief
+    /// Gets an item in the collection.
+    /// 
+    /// \param index 
+    /// Input index of the item to retrieve.
+    /// 
+    /// \return
+    /// Returns the item at the specified index
+    /// 
+    __property OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* get_Item(System::Int32 index);
+
+    /// \brief
+    /// Sets the value of the item at the specified index
+    /// 
+    /// \param index 
+    /// Input index of the item to set.
+    /// 
+    /// \param value 
+    /// Input the value of the item
+    /// 
+    __property System::Void  set_Item(System::Int32 index, OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* value);
+};
+}}}
+