Changes between Version 16 and Version 17 of FDORfc17


Ignore:
Timestamp:
Apr 28, 2008, 9:29:00 AM (16 years ago)
Author:
gregboone
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • FDORfc17

    v16 v17  
     1
     2{{{
     3
     4}}}
    15= FDO RFC 17 - Add a Managed API for the FDO Expression Engine  =
    26
     
    287291};
    288292}}}
     293
     294=== Expression Engine Function Collection ===
     295
     296{{{
     297/// \brief
     298/// The FunctionCollection class represents a collection of Expression Engine IFunction objects.
     299///
     300[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
     301public __sealed __gc class FunctionCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
     302{
     303public:
     304    /// \brief
     305    /// Constructs a FunctionCollection object
     306    ///
     307    /// \param parent
     308    /// Input A Pointer to the parent schema object of the collection
     309    ///
     310    FunctionCollection(NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement* parent);
     311
     312    /// \brief
     313    /// Constructs a FunctionCollection object based on an unmanaged instance of the object
     314    ///
     315    /// \param unmanaged
     316    /// Input A Pointer to the unmanaged object.
     317    ///
     318    /// \param autoDelete
     319    /// Input Indicates if the constructed object should be automatically deleted
     320    /// once it no longer referenced.
     321    ///
     322    FunctionCollection(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
     323    {
     324    }
     325
     326    /// \brief
     327    /// Gets the count of items in collection.
     328    ///
     329    /// \return
     330    /// Returns the number of items in the collection.
     331    ///
     332    __property System::Int32 get_Count(System::Void);
     333
     334    /// \brief
     335    /// Gets an enumerator that can iterate through a collection.
     336    ///
     337    /// \return
     338    /// Returns an enumerator on the dictionary.
     339    ///
     340    __sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
     341
     342    /// \brief
     343    /// Removes the index-th OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction from this collection.
     344    ///
     345    /// \param index
     346    /// Input index of the element to remove.
     347    ///
     348    System::Void RemoveAt(System::Int32 index);
     349
     350    /// \brief
     351    /// Removes all elements from the collection.
     352    ///
     353    System::Void Clear();
     354
     355    /// \brief
     356    /// Adds a IFunction object into the collection.
     357    ///
     358    /// \param value
     359    /// Input the IFunction object to add.
     360    ///
     361    /// \return
     362    /// Returns the position into which the new element was inserted.
     363    ///
     364    System::Int32 Add(OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* value);
     365
     366    /// \brief
     367    /// Determines the index of a specific IFunction object.
     368    ///
     369    /// \param value
     370    /// Input the IFunction object to locate in the collection.
     371    ///
     372    /// \return
     373    /// The index of value if found in the collection; otherwise, -1.
     374    ///
     375    System::Int32 IndexOf(OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* value);
     376
     377    /// \brief
     378    /// Determines the index of a specific IFunction object.
     379    ///
     380    /// \param name
     381    /// Input the name of the object to locate in the collection.
     382    ///
     383    /// \return
     384    /// The index of value if found in the collection; otherwise, -1.
     385    ///
     386    System::Int32 IndexOf(String* name);
     387
     388    /// \brief
     389    /// Inserts a IFunction object into the collection at the specified position.
     390    ///
     391    /// \param index
     392    /// Input the zero-based index at which value should be inserted.
     393    /// \param value
     394    /// Input the IFunction object to insert.
     395    ///
     396    System::Void Insert(System::Int32 index, OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* value);
     397
     398    /// \brief
     399    /// Removes the first occurrence of a specific IFunction object.
     400    ///
     401    /// \param value
     402    /// Input the IFunction object to remove from the collection.
     403    ///
     404    System::Void Remove(OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* value);
     405
     406    /// \brief
     407    /// Determines whether the collection contains a specific IFunction object.
     408    ///
     409    /// \param value
     410    /// Input The IFunction object to search in the collection.
     411    ///
     412    /// \return
     413    /// Returns true if the value is found in the collection; otherwise, false.
     414    ///
     415    System::Boolean Contains(OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* value);
     416
     417    /// \brief
     418    /// Determines whether the collection contains a specific IFunction object.
     419    ///
     420    /// \param name
     421    /// Input The name of the IFunction object to search in the collection.
     422    ///
     423    /// \return
     424    /// Returns true if the value is found in the collection; otherwise, false.
     425    ///
     426    System::Boolean Contains(String* name);
     427
     428    /// \brief
     429    /// Copies the elements of the collection to an array.
     430    ///
     431    /// \param array
     432    /// Output the one-dimensional Array that is the destination of the elements copied from this collection.
     433    ///
     434    /// \param startAt
     435    /// Input an integer that represents the index in array at which copying begins.
     436    ///
     437    System::Void CopyTo(OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* array[],System::Int32 startAt);
     438
     439    /// \brief
     440    /// Gets the item in the collection at the specified index.
     441    ///
     442    /// \param index
     443    /// The index of the item in the collection. The index is 0 based.
     444    ///
     445    /// \return
     446    /// Returns an instance of a the collected item.
     447    /// Throws an instance of Exception if the index is out of range or an error occurs.
     448    ///
     449    __property OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* get_RealTypeItem(System::Int32 index);
     450
     451    /// \brief
     452    /// Gets the item in the collection by name.
     453    ///
     454    /// \param index
     455    /// The name of the item in the collection.
     456    ///
     457    /// \return
     458    /// Returns an instance of a the collected item.
     459    ///
     460    __property OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* get_RealTypeItem(System::String* index);
     461
     462    /// \brief
     463    /// Sets the value of the item at the specified index
     464    ///
     465    /// \param index
     466    /// Input index of the item to set.
     467    ///
     468    /// \param value
     469    /// Input the value of the item
     470    ///
     471    __property System::Void  set_RealTypeItem(System::Int32 index, OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* value);
     472
     473    /// \brief
     474    /// Gets an item in the collection.
     475    ///
     476    /// \param index
     477    /// Input index of the item to retrieve.
     478    ///
     479    /// \return
     480    /// Returns the item at the specified index
     481    ///
     482    __property OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* get_Item(System::Int32 index);
     483
     484    /// \brief
     485    /// Sets the value of the item at the specified index
     486    ///
     487    /// \param index
     488    /// Input index of the item to set.
     489    ///
     490    /// \param value
     491    /// Input the value of the item
     492    ///
     493    __property System::Void  set_Item(System::Int32 index, OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::IFunction* value);
     494};
     495}}}
     496