[fdo-commits] r709 - in
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections: . Capabilities
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Thu Feb 1 20:03:17 EST 2007
Author: gregboone
Date: 2007-02-01 20:03:17 -0500 (Thu, 01 Feb 2007)
New Revision: 709
Modified:
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgArgumentDefinition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgArgumentDefinitionCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgFunctionDefinition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgFunctionDefinitionCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgICommandCapabilities.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgICommandCapabilitiesImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIConnectionCapabilities.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIConnectionCapabilitiesImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIExpressionCapabilities.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIExpressionCapabilitiesImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIFilterCapabilities.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIFilterCapabilitiesImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIGeometryCapabilities.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIGeometryCapabilitiesImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIRasterCapabilities.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIRasterCapabilitiesImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgISchemaCapabilities.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgISchemaCapabilitiesImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgITopologyCapabilities.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgITopologyCapabilitiesImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgReadOnlyArgDefColl.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgSchemaElementNameType.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgSignatureDefinition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgThreadCapability.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgConnectionState.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionInfo.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionInfoImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionPropertyDictionary.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionPropertyDictionaryImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgITransaction.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgITransactionImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgProviderDatastoreType.h
Log:
893057: DOC: FDO Managed API Documentation Updates
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgArgumentDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgArgumentDefinition.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgArgumentDefinition.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -27,12 +27,12 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
/// \brief
-/// The FdoArgumentDefinition class contains metadata that describes an argument to a function.
+/// The ArgumentDefinition class contains metadata that describes an argument to a function.
public __gc class ArgumentDefinition : public NAMESPACE_OSGEO_RUNTIME::Disposable
{
public:
/// \brief
- /// Constructs an instance of an FdoArgumentDefinition using the specified arguments.
+ /// Constructs an instance of an ArgumentDefinition using the specified arguments.
///
/// \param name
/// Input the name of the argument.
@@ -42,7 +42,7 @@
/// Input the type of argument.
///
/// \return
- /// Returns FdoArgumentDefinition
+ /// Returns ArgumentDefinition
///
ArgumentDefinition(System::String* name, System::String* description, NAMESPACE_OSGEO_FDO_SCHEMA::DataType dataType);
@@ -63,7 +63,7 @@
__property System::String* get_Description();
/// \brief
- /// Gets the FdoDataType of the argument.
+ /// Gets the PropertyType of the argument.
///
/// \return
/// Returns the property type of the argument
@@ -71,15 +71,17 @@
__property NAMESPACE_OSGEO_FDO_SCHEMA::PropertyType get_PropertyType();
/// \brief
- /// Gets the FdoDataType of the argument.
+ /// Gets the DataType of the argument.
///
/// \return
/// Returns the data type of the argument
///
__property NAMESPACE_OSGEO_FDO_SCHEMA::DataType get_DataType();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
ArgumentDefinition(System::IntPtr unmanaged, System::Boolean autoDelete);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgArgumentDefinitionCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgArgumentDefinitionCollection.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgArgumentDefinitionCollection.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -24,13 +24,32 @@
public __gc class ArgumentDefinition;
/// \brief
-/// FdoArgumentDefinitionCollection is a collection of name-value pairs.
+/// ArgumentDefinitionCollection is a collection of ArgumentDefinition objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class ArgumentDefinitionCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
+/// \cond DOXYGEN-IGNORE
private:
/// \brief
- /// nested class defined to provide Enumerator.
+ /// 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
{
@@ -39,15 +58,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(ArgumentDefinitionCollection* elements) : m_pCol(elements), m_nIdx(-1)
{
}
- __property System::Object* get_Current();
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
+ __property System::Object *get_Current();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first object 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 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();
};
@@ -57,47 +108,48 @@
inline FdoArgumentDefinitionCollection* GetImpObj();
private:
- /// System::Collections::ICollection interfaces
- System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
+ // System::Collections::ICollection interface properties
+ __property System::Object* System::Collections::ICollection::get_SyncRoot();
+ __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
- __property System::Object* System::Collections::ICollection::get_SyncRoot();
+ // System::Collections::ICollection interface methods
+ System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
- __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
+ // 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 interfaces
- __property System::Boolean System::Collections::IList::get_IsFixedSize();
+ // 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
- __property System::Boolean System::Collections::IList::get_IsReadOnly();
-
- 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);
-
- __property Object* System::Collections::IList::get_Item(System::Int32 index);
-
- __property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
-
public:
ArgumentDefinitionCollection();
/// \brief
- /// Gets the count of items in collection.
+ /// 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.
+ /// 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 ArgumentDefinition from this collection.
+ /// Removes the index-th ArgumentDefinition from this collection.
///
/// \param index
/// Input index of the element to remove.
@@ -105,34 +157,34 @@
System::Void RemoveAt(System::Int32 index);
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
/// \brief
- /// Adds a ArgumentDefinition object into the collection.
+ /// Adds a ArgumentDefinition object into the collection.
///
/// \param value
/// Input the ArgumentDefinition object to add.
///
/// \return
- /// Returns the position into which the new element was inserted.
+ /// Returns the position into which the new element was inserted.
///
System::Int32 Add(ArgumentDefinition* value);
/// \brief
- /// Determines the index of a specific ArgumentDefinition object.
+ /// Determines the index of a specific ArgumentDefinition object.
///
/// \param value
/// Input the ArgumentDefinition object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::ArgumentDefinition* value);
/// \brief
- /// Inserts a ArgumentDefinition object into the collection at the specified position.
+ /// Inserts a ArgumentDefinition object into the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
@@ -142,7 +194,7 @@
System::Void Insert(System::Int32 index, ArgumentDefinition* value);
/// \brief
- /// Removes the first occurrence of a specific ArgumentDefinition object.
+ /// Removes the first occurrence of a specific ArgumentDefinition object.
///
/// \param value
/// Input the ArgumentDefinition object to remove from the collection.
@@ -150,18 +202,18 @@
System::Void Remove(ArgumentDefinition* value);
/// \brief
- /// Determines whether the collection contains a specific ArgumentDefinition object.
+ /// Determines whether the collection contains a specific ArgumentDefinition object.
///
/// \param value
/// Input The ArgumentDefinition object to search in the collection.
///
/// \return
- /// Returns true if the value is found in the collection; otherwise, false.
+ /// Returns true if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(ArgumentDefinition* value);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// 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.
@@ -170,23 +222,55 @@
///
System::Void CopyTo(ArgumentDefinition* array[],System::Int32 size);
-
/// \brief
- /// Gets or sets a ArgumentDefinition in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the ArgumentDefinition to retrieve or set (System::Int32).
+ /// 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 ArgumentDefinition* get_RealTypeItem(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_RealTypeItem(System::Int32 index, ArgumentDefinition* 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 ArgumentDefinition* 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, ArgumentDefinition* value);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgFunctionDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgFunctionDefinition.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgFunctionDefinition.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -138,8 +138,10 @@
/// Returns true if the function is an aggregate function and false if it is a simple function.
__property System::Boolean get_IsAggregate();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
FunctionDefinition(System::IntPtr unmanaged, System::Boolean autoDelete);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgFunctionDefinitionCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgFunctionDefinitionCollection.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgFunctionDefinitionCollection.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -24,13 +24,32 @@
public __gc class FunctionDefinition;
/// \brief
-/// FdoFunctionDefinitionCollection is a collection of name-value pairs.
+/// FunctionDefinitionCollection is a collection of FunctionDefinition objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class FunctionDefinitionCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
+/// \cond DOXYGEN-IGNORE
private:
/// \brief
- /// nested class defined to provide Enumerator.
+ /// 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
{
@@ -39,15 +58,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(FunctionDefinitionCollection* elements) : m_pCol(elements), m_nIdx(-1)
{
}
- __property System::Object* get_Current();
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
+ __property System::Object *get_Current();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first object 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 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();
};
@@ -57,47 +108,48 @@
inline FdoFunctionDefinitionCollection* GetImpObj();
private:
- /// System::Collections::ICollection interfaces
- System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
+ // System::Collections::ICollection interface properties
+ __property System::Object* System::Collections::ICollection::get_SyncRoot();
+ __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
- __property System::Object* System::Collections::ICollection::get_SyncRoot();
+ // System::Collections::ICollection interface methods
+ System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
- __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
+ // 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 interfaces
- __property System::Boolean System::Collections::IList::get_IsFixedSize();
+ // 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
- __property System::Boolean System::Collections::IList::get_IsReadOnly();
-
- 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);
-
- __property Object* System::Collections::IList::get_Item(System::Int32 index);
-
- __property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
-
public:
FunctionDefinitionCollection();
/// \brief
- /// Gets the count of items in collection.
+ /// 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.
+ /// 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 FunctionDefinition from this collection.
+ /// Removes the index-th FunctionDefinition from this collection.
///
/// \param index
/// Input index of the element to remove.
@@ -105,36 +157,36 @@
System::Void RemoveAt(System::Int32 index);
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
/// \brief
- /// Adds a FunctionDefinition object into the collection.
+ /// Adds a FunctionDefinition object into the collection.
///
/// \param value
/// Input the FunctionDefinition object to add.
///
/// \return
- /// Returns the position into which the new element was inserted.
+ /// Returns the position into which the new element was inserted.
///
System::Int32 Add(FunctionDefinition* value);
/// \brief
- /// Determines the index of a specific FunctionDefinition object.
+ /// Determines the index of a specific FunctionDefinition object.
///
/// \param value
/// Input the FunctionDefinition object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::FunctionDefinition* value);
System::Int32 IndexOf(System::String* value);
/// \brief
- /// Inserts a FunctionDefinition object into the collection at the specified position.
+ /// Inserts a FunctionDefinition object into the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
@@ -144,7 +196,7 @@
System::Void Insert(System::Int32 index, FunctionDefinition* value);
/// \brief
- /// Removes the first occurrence of a specific FunctionDefinition object.
+ /// Removes the first occurrence of a specific FunctionDefinition object.
///
/// \param value
/// Input the FunctionDefinition object to remove from the collection.
@@ -152,20 +204,29 @@
System::Void Remove(FunctionDefinition* value);
/// \brief
- /// Determines whether the collection contains a specific FunctionDefinition object.
+ /// Determines whether the collection contains a specific FunctionDefinition object.
///
/// \param value
/// Input The FunctionDefinition object to search in the collection.
///
/// \return
- /// Returns true if the value is found in the collection; otherwise, false.
+ /// Returns true if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(FunctionDefinition* value);
+ /// \brief
+ /// Determines whether the collection contains a specific FunctionDefinition object.
+ ///
+ /// \param value
+ /// Input The name of the FunctionDefinition object to search in the collection.
+ ///
+ /// \return
+ /// Returns true if the value is found in the collection; otherwise, false.
+ ///
System::Boolean Contains(System::String* value);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// 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.
@@ -174,23 +235,55 @@
///
System::Void CopyTo(FunctionDefinition* array[],System::Int32 size);
-
/// \brief
- /// Gets or sets a FunctionDefinition in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the FunctionDefinition to retrieve or set (System::Int32).
+ /// 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 FunctionDefinition* get_RealTypeItem(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_RealTypeItem(System::Int32 index, FunctionDefinition* 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 FunctionDefinition* 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, FunctionDefinition* value);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgICommandCapabilities.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgICommandCapabilities.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgICommandCapabilities.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -21,13 +21,13 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
/// \brief
-/// The FdoICommandCapabilities interface declares the feature provider's level
+/// The ICommandCapabilities interface declares the feature provider's level
/// of support for Commands.
public __gc __interface ICommandCapabilities : public System::IDisposable
{
public:
/// \brief
- /// Gets an array of the FdoCommandType values supported by the feature provider.
+ /// Gets an array of the CommandType values supported by the feature provider.
///
/// \param size
/// Output the number of commands
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgICommandCapabilitiesImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgICommandCapabilitiesImp.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgICommandCapabilitiesImp.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -25,13 +25,14 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
/// \brief
-/// The FdoICommandCapabilities interface declares the feature provider's level
+/// The ICommandCapabilities interface declares the feature provider's level
/// of support for Commands.
-public __gc class ICommandCapabilitiesImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::ICommandCapabilities
+public __gc class ICommandCapabilitiesImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::ICommandCapabilities
{
public:
/// \brief
- /// Gets an array of the FdoCommandType values supported by the feature provider.
+ /// Gets an array of the CommandType values supported by the feature provider.
///
/// \param size
/// Output the number of commands
@@ -103,8 +104,10 @@
/// (but not vice versa).
System::Boolean SupportsSelectGrouping();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
ICommandCapabilitiesImp(System::IntPtr unmanaged, System::Boolean autoDelete);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIConnectionCapabilities.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIConnectionCapabilities.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIConnectionCapabilities.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -33,12 +33,12 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
/// \brief
-/// The FdoIConnectionCapabilities interface declares the feature provider's capabilities.
+/// The IConnectionCapabilities interface declares the feature provider's capabilities.
public __gc __interface IConnectionCapabilities : public System::IDisposable
{
public:
/// \brief
- /// Gets an FdoThreadCapability value that declares the feature provider's level of thread safety.
+ /// Gets an ThreadCapability value that declares the feature provider's level of thread safety.
///
/// \return
/// Returns the connection thread capability.
@@ -65,7 +65,7 @@
System::Boolean SupportsLocking();
/// \brief
- /// Gets an array of the FdoLockType values supported by the feature provider.
+ /// Gets an array of the LockType values supported by the feature provider.
///
/// \param size
/// Output the number of lock types
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIConnectionCapabilitiesImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIConnectionCapabilitiesImp.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIConnectionCapabilitiesImp.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -27,12 +27,13 @@
public __value enum ThreadCapability;
/// \brief
-/// The FdoIConnectionCapabilities interface declares the feature provider's capabilities.
-private __gc class IConnectionCapabilitiesImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::IConnectionCapabilities
+/// The IConnectionCapabilities interface declares the feature provider's capabilities.
+private __gc class IConnectionCapabilitiesImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::IConnectionCapabilities
{
public:
/// \brief
- /// Gets an FdoThreadCapability value that declares the feature provider's level of thread safety.
+ /// Gets an ThreadCapability value that declares the feature provider's level of thread safety.
///
/// \return
/// Returns the connection thread capability.
@@ -59,7 +60,7 @@
System::Boolean SupportsLocking();
/// \brief
- /// Gets an array of the FdoLockType values supported by the feature provider.
+ /// Gets an array of the LockType values supported by the feature provider.
///
/// \param size
/// Output the number of lock types
@@ -141,8 +142,10 @@
inline FdoIConnectionCapabilities* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIExpressionCapabilities.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIExpressionCapabilities.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIExpressionCapabilities.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -29,13 +29,13 @@
public __gc class FunctionDefinitionCollection;
/// \brief
-/// The FdoIExpressionCapbilities interface declares the feature provider's level
-/// of support for FdoExpression classes.
+/// The IExpressionCapbilities interface declares the feature provider's level
+/// of support for Expression classes.
public __gc __interface IExpressionCapabilities : public System::IDisposable
{
public:
/// \brief
- /// Returns an array of FdoExpressionType objects the feature provider supports.
+ /// Returns an array of ExpressionType objects the feature provider supports.
///
/// \param length
/// Input the number of expression types
@@ -46,7 +46,7 @@
__property NAMESPACE_OSGEO_FDO_EXPRESSION::ExpressionType get_ExpressionTypes() [];
/// \brief
- /// Returns a collection of FdoFunctionDefinition objects the feature provider supports within expressions.
+ /// Returns a collection of FunctionDefinition objects the feature provider supports within expressions.
///
/// \return
/// Returns the collection of function definitions
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIExpressionCapabilitiesImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIExpressionCapabilitiesImp.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIExpressionCapabilitiesImp.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -25,13 +25,14 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
/// \brief
-/// The FdoIExpressionCapbilities interface declares the feature provider's level
-/// of support for FdoExpression classes.
-private __gc class IExpressionCapabilitiesImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::IExpressionCapabilities
+/// The IExpressionCapbilities interface declares the feature provider's level
+/// of support for Expression classes.
+private __gc class IExpressionCapabilitiesImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::IExpressionCapabilities
{
public:
/// \brief
- /// Returns an array of FdoExpressionType objects the feature provider supports.
+ /// Returns an array of ExpressionType objects the feature provider supports.
///
/// \param length
/// Input the number of expression types
@@ -42,15 +43,17 @@
__property NAMESPACE_OSGEO_FDO_EXPRESSION::ExpressionType get_ExpressionTypes() [];
/// \brief
- /// Returns a collection of FdoFunctionDefinition objects the feature provider supports within expressions.
+ /// Returns a collection of FunctionDefinition objects the feature provider supports within expressions.
///
/// \return
/// Returns the collection of function definitions
///
__property NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::FunctionDefinitionCollection* get_Functions();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
IExpressionCapabilitiesImp(System::IntPtr unmanaged, System::Boolean autoDelete);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIFilterCapabilities.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIFilterCapabilities.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIFilterCapabilities.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -31,12 +31,12 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
/// \brief
-/// The FdoIFilterCapabilities interface declares the feature provider's level of support for FdoFilter classes.
+/// The IFilterCapabilities interface declares the feature provider's level of support for Filter classes.
public __gc __interface IFilterCapabilities : public System::IDisposable
{
public:
/// \brief
- /// Returns an array of FdoConditionType objects the feature provider supports.
+ /// Returns an array of ConditionType objects the feature provider supports.
///
/// \param length
/// Output the number of condition types
@@ -47,7 +47,7 @@
__property NAMESPACE_OSGEO_FDO_FILTER::ConditionType get_ConditionTypes() [];
/// \brief
- /// Returns an array of FdoSpatialOperation objects the feature provider supports.
+ /// Returns an array of SpatialOperation objects the feature provider supports.
///
/// \param length
/// Output the number of spatial operations
@@ -58,7 +58,7 @@
__property NAMESPACE_OSGEO_FDO_FILTER::SpatialOperations get_SpatialOperations() [];
/// \brief
- /// Returns an array of FdoDistanceOperation objects the feature provider supports.
+ /// Returns an array of DistanceOperation objects the feature provider supports.
///
/// \param length
/// Output the number of distance operations
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIFilterCapabilitiesImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIFilterCapabilitiesImp.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIFilterCapabilitiesImp.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -25,12 +25,13 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
/// \brief
-/// The FdoIFilterCapabilities interface declares the feature provider's level of support for FdoFilter classes.
-private __gc class IFilterCapabilitiesImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::IFilterCapabilities
+/// The IFilterCapabilities interface declares the feature provider's level of support for Filter classes.
+private __gc class IFilterCapabilitiesImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::IFilterCapabilities
{
public:
/// \brief
- /// Returns an array of FdoConditionType objects the feature provider supports.
+ /// Returns an array of ConditionType objects the feature provider supports.
///
/// \param length
/// Output the number of condition types
@@ -41,7 +42,7 @@
__property NAMESPACE_OSGEO_FDO_FILTER::ConditionType get_ConditionTypes() [];
/// \brief
- /// Returns an array of FdoSpatialOperation objects the feature provider supports.
+ /// Returns an array of SpatialOperation objects the feature provider supports.
///
/// \param length
/// Output the number of spatial operations
@@ -52,7 +53,7 @@
__property NAMESPACE_OSGEO_FDO_FILTER::SpatialOperations get_SpatialOperations() [];
/// \brief
- /// Returns an array of FdoDistanceOperation objects the feature provider supports.
+ /// Returns an array of DistanceOperation objects the feature provider supports.
///
/// \param length
/// Output the number of distance operations
@@ -80,8 +81,10 @@
///
System::Boolean SupportsNonLiteralGeometricOperations();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
IFilterCapabilitiesImp(System::IntPtr unmanaged, System::Boolean autoDelete);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIGeometryCapabilities.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIGeometryCapabilities.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIGeometryCapabilities.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -21,7 +21,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
/// \brief
-/// The FdoIGeometryCapabilities class delineates available support for raster processing from a provider.
+/// The IGeometryCapabilities class delineates available support for raster processing from a provider.
public __gc __interface IGeometryCapabilities : public System::IDisposable
{
public:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIGeometryCapabilitiesImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIGeometryCapabilitiesImp.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIGeometryCapabilitiesImp.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -25,8 +25,9 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
/// \brief
-/// The FdoIGeometryCapabilities class delineates available support for raster processing from a provider.
-private __gc class IGeometryCapabilitiesImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::IGeometryCapabilities
+/// The IGeometryCapabilities class delineates available support for raster processing from a provider.
+private __gc class IGeometryCapabilitiesImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::IGeometryCapabilities
{
public:
/// \brief
@@ -62,8 +63,10 @@
///
__property System::Int32 get_Dimensionalities();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
IGeometryCapabilitiesImp(System::IntPtr unmanaged, System::Boolean autoDelete);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIRasterCapabilities.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIRasterCapabilities.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIRasterCapabilities.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -26,7 +26,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
/// \brief
-/// The FdoIRasterCapabilities class delineates available support for raster processing from a provider.
+/// The IRasterCapabilities class delineates available support for raster processing from a provider.
public __gc __interface IRasterCapabilities : public System::IDisposable
{
public:
@@ -46,8 +46,8 @@
///
/// \return
/// Returns false if this capability is not supported, and hence the
- /// FdoIFeatureReader object returned from a select command will have one feature
- /// for each of the FdoIRaster objects that match the select filter.
+ /// IFeatureReader object returned from a select command will have one feature
+ /// for each of the IRaster objects that match the select filter.
/// Returns true if this capability is supported. If the MOSAIC function
/// is specified in the select command, then a single image that is a combination
/// of the selected images is returned.
@@ -58,12 +58,12 @@
/// Returns true if the provider can reduce the resolution of an image.
///
/// \return
- /// Returns true if this capability is supported, and hence the FdoIRaster
- /// object returned by the FdoIFeatureReader from a query will honour the
+ /// Returns true if this capability is supported, and hence the IRaster
+ /// object returned by the IFeatureReader from a query will honour the
/// SetImageXSize() and SetImageYSize() methods and reduce the resolution of the
/// image by one of several means of subsampling. Returns false if attempting to set
- /// the image size of an FdoIRaster object returned by a FdoIFeatureReader will
- /// throw an FdoException.
+ /// the image size of an IRaster object returned by a IFeatureReader will
+ /// throw an Exception.
///
System::Boolean SupportsSubsampling ();
@@ -77,7 +77,7 @@
///
/// \return
/// Returns true if the specified data model is supported, and hence the
- /// FdoIRaster object will dynamically transform an image to the specified data model.
+ /// IRaster object will dynamically transform an image to the specified data model.
/// Returns false if the specified data model is not supported.
///
System::Boolean SupportsDataModel (NAMESPACE_OSGEO_FDO_RASTER::RasterDataModel* model);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIRasterCapabilitiesImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIRasterCapabilitiesImp.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgIRasterCapabilitiesImp.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -25,8 +25,9 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
/// \brief
-/// The FdoIRasterCapabilities class delineates available support for raster processing from a provider.
-private __gc class IRasterCapabilitiesImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::IRasterCapabilities
+/// The IRasterCapabilities class delineates available support for raster processing from a provider.
+private __gc class IRasterCapabilitiesImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::IRasterCapabilities
{
public:
/// \brief
@@ -45,8 +46,8 @@
///
/// \return
/// Returns false if this capability is not supported, and hence the
- /// FdoIFeatureReader object returned from a select command will have one feature
- /// for each of the FdoIRaster objects that match the select filter.
+ /// IFeatureReader object returned from a select command will have one feature
+ /// for each of the IRaster objects that match the select filter.
/// Returns true if this capability is supported. If the MOSAIC function
/// is specified in the select command, then a single image that is a combination
/// of the selected images is returned.
@@ -57,12 +58,12 @@
/// Returns true if the provider can reduce the resolution of an image.
///
/// \return
- /// Returns true if this capability is supported, and hence the FdoIRaster
- /// object returned by the FdoIFeatureReader from a query will honour the
+ /// Returns true if this capability is supported, and hence the IRaster
+ /// object returned by the IFeatureReader from a query will honour the
/// SetImageXSize() and SetImageYSize() methods and reduce the resolution of the
/// image by one of several means of subsampling. Returns false if attempting to set
- /// the image size of an FdoIRaster object returned by a FdoIFeatureReader will
- /// throw an FdoException.
+ /// the image size of an IRaster object returned by a IFeatureReader will
+ /// throw an Exception.
///
System::Boolean SupportsSubsampling ();
@@ -76,13 +77,15 @@
///
/// \return
/// Returns true if the specified data model is supported, and hence the
- /// FdoIRaster object will dynamically transform an image to the specified data model.
+ /// IRaster object will dynamically transform an image to the specified data model.
/// Returns false if the specified data model is not supported.
///
System::Boolean SupportsDataModel (NAMESPACE_OSGEO_FDO_RASTER::RasterDataModel* model);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
IRasterCapabilitiesImp(System::IntPtr unmanaged, System::Boolean autoDelete);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgISchemaCapabilities.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgISchemaCapabilities.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgISchemaCapabilities.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -33,13 +33,13 @@
public __value enum SchemaElementNameType;
/// \brief
-/// The FdoISchemaCapbilities interface declares the feature provider's level
+/// The ISchemaCapbilities interface declares the feature provider's level
/// of support for the Feature Schema.
public __gc __interface ISchemaCapabilities : public System::IDisposable
{
public:
/// \brief
- /// Returns an array of the FdoClassType objects the feature provider supports.
+ /// Returns an array of the ClassType objects the feature provider supports.
///
/// \param length
/// Output the number of class types.
@@ -50,7 +50,7 @@
__property NAMESPACE_OSGEO_FDO_SCHEMA::ClassType get_ClassTypes() [];
/// \brief
- /// Returns an array of the FdoDataType objects the feature provider supports.
+ /// Returns an array of the DataType objects the feature provider supports.
///
/// \param length
/// Output the number of data types.
@@ -103,9 +103,9 @@
///
/// \param name
/// The schema element name type identifier for which the information is to
- /// be retrieved. Can be any of the following options: FdoSchemaElementNameType_Datastore,
- /// FdoSchemaElementNameType_Schema, FdoSchemaElementNameType_Class, FdoSchemaElementNameType_Property or
- /// FdoSchemaElementNameType_Description
+ /// be retrieved. Can be any of the following options: SchemaElementNameType_Datastore,
+ /// SchemaElementNameType_Schema, SchemaElementNameType_Class, SchemaElementNameType_Property or
+ /// SchemaElementNameType_Description
///
/// \return
/// Returns the size limitation for the identified schema element.
@@ -125,7 +125,7 @@
__property System::String* get_ReservedCharactersForName();
/// \brief
- /// Returns an array of the FdoDataType objects the feature provider supports for auto-generation.
+ /// Returns an array of the DataType objects the feature provider supports for auto-generation.
///
/// \param length
/// Output the number of data types.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgISchemaCapabilitiesImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgISchemaCapabilitiesImp.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgISchemaCapabilitiesImp.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -25,13 +25,14 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
/// \brief
-/// The FdoISchemaCapbilities interface declares the feature provider's level
+/// The ISchemaCapbilities interface declares the feature provider's level
/// of support for the Feature Schema.
-private __gc class ISchemaCapabilitiesImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::ISchemaCapabilities
+private __gc class ISchemaCapabilitiesImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::ISchemaCapabilities
{
public:
/// \brief
- /// Returns an array of the FdoClassType objects the feature provider supports.
+ /// Returns an array of the ClassType objects the feature provider supports.
///
/// \param length
/// Output the number of class types.
@@ -42,7 +43,7 @@
__property NAMESPACE_OSGEO_FDO_SCHEMA::ClassType get_ClassTypes() [];
/// \brief
- /// Returns an array of the FdoDataType objects the feature provider supports.
+ /// Returns an array of the DataType objects the feature provider supports.
///
/// \param length
/// Output the number of data types.
@@ -95,9 +96,9 @@
///
/// \param name
/// The schema element name type identifier for which the information is to
- /// be retrieved. Can be any of the following options: FdoSchemaElementNameType_Datastore,
- /// FdoSchemaElementNameType_Schema, FdoSchemaElementNameType_Class, FdoSchemaElementNameType_Property or
- /// FdoSchemaElementNameType_Description
+ /// be retrieved. Can be any of the following options: SchemaElementNameType_Datastore,
+ /// SchemaElementNameType_Schema, SchemaElementNameType_Class, SchemaElementNameType_Property or
+ /// SchemaElementNameType_Description
///
/// \return
/// Returns the size limitation for the identified schema element.
@@ -117,7 +118,7 @@
__property System::String* get_ReservedCharactersForName();
/// \brief
- /// Returns an array of the FdoDataType objects the feature provider supports for auto-generation.
+ /// Returns an array of the DataType objects the feature provider supports for auto-generation.
///
/// \param length
/// Output the number of data types.
@@ -284,14 +285,10 @@
///
__property System::Boolean get_SupportsValueConstraintsList();
-
-
-
-
-
-
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
ISchemaCapabilitiesImp(System::IntPtr unmanaged, System::Boolean autoDelete);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgITopologyCapabilities.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgITopologyCapabilities.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgITopologyCapabilities.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -27,7 +27,7 @@
/// FDO supports properties that inform the client code about capabilities that
/// may vary between providers.
/// <p><b>Note:</b> <span class="red_text">This Help topic is provided for informational use only. There is
-/// no interface or support provided. Autodesk reserves the right to change
+/// no interface or support provided. OSGeo reserves the right to change
/// the software related to the content herein.</span>
public __gc __interface ITopologyCapabilities : public System::IDisposable
{
@@ -38,7 +38,7 @@
/// True if the provider supports TopoGeometry properties that depend on
/// each other in a hierarchy; if this is false, attempting to set a
- /// non-NULL for FdoTopoGeometryPropertyDefinition's "DependsOnTopoGeometry"
+ /// non-NULL for TopoGeometryPropertyDefinition's "DependsOnTopoGeometry"
/// property will fail.
System::Boolean SupportsTopologicalHierarchy();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgITopologyCapabilitiesImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgITopologyCapabilitiesImp.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgITopologyCapabilitiesImp.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -28,9 +28,10 @@
/// FDO supports properties that inform the client code about capabilities that
/// may vary between providers.
/// <p><b>Note:</b> <span class="red_text">This Help topic is provided for informational use only. There is
-/// no interface or support provided. Autodesk reserves the right to change
+/// no interface or support provided. OSGeo reserves the right to change
/// the software related to the content herein.</span>
-private __gc class ITopologyCapabilitiesImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::ITopologyCapabilities
+private __gc class ITopologyCapabilitiesImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::ITopologyCapabilities
{
public:
/// True if the provider supports topology; if this is false, attempts to
@@ -39,7 +40,7 @@
/// True if the provider supports TopoGeometry properties that depend on
/// each other in a hierarchy; if this is false, attempting to set a
- /// non-NULL for FdoTopoGeometryPropertyDefinition's "DependsOnTopoGeometry"
+ /// non-NULL for TopoGeometryPropertyDefinition's "DependsOnTopoGeometry"
/// property will fail.
System::Boolean SupportsTopologicalHierarchy();
@@ -56,8 +57,10 @@
/// geometry value) to those that do not change topological relationships.
System::Boolean ConstrainsFeatureMovements();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
ITopologyCapabilitiesImp(System::IntPtr unmanaged, System::Boolean autoDelete);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgReadOnlyArgDefColl.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgReadOnlyArgDefColl.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgReadOnlyArgDefColl.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -24,13 +24,32 @@
public __gc class ArgumentDefinition;
/// \brief
-/// FdoArgumentDefinitionCollection is a collection of name-value pairs.
+/// ReadOnlyArgumentDefinitionCollection is a collection of ReadOnlyArgumentDefinition objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class ReadOnlyArgumentDefinitionCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::ICollection, public System::Collections::IEnumerable
{
+/// \cond DOXYGEN-IGNORE
private:
/// \brief
- /// nested class defined to provide Enumerator.
+ /// 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
{
@@ -39,15 +58,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(ReadOnlyArgumentDefinitionCollection* elements) : m_pCol(elements), m_nIdx(-1)
{
}
- __property System::Object* get_Current();
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
+ __property System::Object *get_Current();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first object 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 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();
};
@@ -57,28 +108,35 @@
inline FdoReadOnlyArgumentDefinitionCollection* GetImpObj();
private:
- // System::Collections::ICollection interfaces
+ // System::Collections::ICollection methods
System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
+ // System::Collections::ICollection properties
__property System::Object* System::Collections::ICollection::get_SyncRoot();
-
__property System::Boolean System::Collections::ICollection::get_IsSynchronized();
+/// \endcond
public:
ReadOnlyArgumentDefinitionCollection();
/// \brief
- /// Gets the count of items in collection.
+ /// 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.
+ /// Gets an enumerator that can iterate through a collection.
///
+ /// \return
+ /// Returns an enumerator on the dictionary.
+ ///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// 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.
@@ -88,39 +146,54 @@
System::Void CopyTo(NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::ArgumentDefinition* array[], System::Int32 index);
/// \brief
- /// Determines the index of a specific ArgumentDefinition object.
+ /// Determines the index of a specific ArgumentDefinition object.
///
/// \param value
/// Input the ArgumentDefinition object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::ArgumentDefinition* value);
/// \brief
- /// Determines whether the collection contains a specific ArgumentDefinition object.
+ /// Determines whether the collection contains a specific ArgumentDefinition object.
///
/// \param value
/// Input The ArgumentDefinition object to search in the collection.
///
/// \return
- /// Returns true if the value is found in the collection; otherwise, false.
+ /// Returns true if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(ArgumentDefinition* value);
/// \brief
- /// Gets or sets a ArgumentDefinition in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the ArgumentDefinition to retrieve or set (System::Int32).
+ /// 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 ArgumentDefinition* get_RealTypeItem(System::Int32 index);
+ /// \brief
+ /// Gets the item in the collection at the specified index.
+ ///
+ /// \param index
+ /// The name of the item in the collection.
+ ///
+ /// \return
+ /// Returns an instance of a the collected item.
+ ///
__property ArgumentDefinition* get_RealTypeItem(System::String* name);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgSchemaElementNameType.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgSchemaElementNameType.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgSchemaElementNameType.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -20,7 +20,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
/// \brief
-/// The FdoSchemaElementNameType enumeration lists all of the concrete schema name
+/// The SchemaElementNameType enumeration lists all of the concrete schema name
/// types defined to address schema limitation information.
/// <param name="SchemaElementNameType_Datastore">
/// Represents the identifier to address a data store name
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgSignatureDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgSignatureDefinition.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgSignatureDefinition.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -45,21 +45,22 @@
NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::ArgumentDefinitionCollection *arguments);
/// \brief
- /// Gets an array of FdoArgumentDefinition objects required for the function.
+ /// Gets an array of ArgumentDefinition objects required for the function.
__property NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::ReadOnlyArgumentDefinitionCollection *get_Arguments();
/// \brief
- /// Gets the FdoPropertyType of the function return value.
+ /// Gets the PropertyType of the function return value.
__property NAMESPACE_OSGEO_FDO_SCHEMA::PropertyType get_ReturnPropertyType();
/// \brief
- /// Gets the FdoDataType of the function return value. This is only valid if the function return property type is
- /// FdoPropertyType_DataProperty.
+ /// Gets the DataType of the function return value. This is only valid if the function return property type is
+ /// PropertyType_DataProperty.
__property NAMESPACE_OSGEO_FDO_SCHEMA::DataType get_ReturnType();
-
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
SignatureDefinition(System::IntPtr unmanaged, System::Boolean autoDelete);
@@ -70,12 +71,34 @@
// -----------------------------------------------------------------------------------------------------
+/// \brief
+/// SignatureDefinitionCollection is a collection of SignatureDefinition elements.
+///
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class SignatureDefinitionCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
+/// \cond DOXYGEN-IGNORE
private:
/// \brief
- /// nested class defined to provide Enumerator.
+ /// 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
{
@@ -84,15 +107,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(SignatureDefinitionCollection* elements) : m_pCol(elements), m_nIdx(-1)
{
}
- __property System::Object* get_Current();
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
+ __property System::Object *get_Current();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first object 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 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();
};
@@ -102,148 +157,202 @@
inline FdoSignatureDefinitionCollection *GetImpObj();
private:
- /// System::Collections::ICollection interfaces
- System::Void System::Collections::ICollection::CopyTo(System::Array *array, System::Int32 index);
+ // System::Collections::ICollection interface properties
+ __property System::Object* System::Collections::ICollection::get_SyncRoot();
+ __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
- __property System::Object *System::Collections::ICollection::get_SyncRoot();
+ // System::Collections::ICollection interface methods
+ System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
- __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
+ // 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 interfaces
- __property System::Boolean System::Collections::IList::get_IsFixedSize();
+ // 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
- __property System::Boolean System::Collections::IList::get_IsReadOnly();
-
- 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);
-
- __property Object *System::Collections::IList::get_Item(System::Int32 index);
-
- __property System::Void System::Collections::IList::set_Item(System::Int32 index, Object *value);
-
public:
SignatureDefinitionCollection();
/// \brief
- /// Gets the count of items in collection.
+ /// 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.
+ /// 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 SignatureDefinition from this collection.
+ /// Removes the index-th SignatureDefinition from this collection.
///
/// \param index
- /// Input index of the element to remove.
+ /// Input index of the element to remove.
///
System::Void RemoveAt(System::Int32 index);
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
/// \brief
- /// Adds a SignatureDefinition object into the collection.
+ /// Adds a SignatureDefinition object into the collection.
///
/// \param value
- /// Input the SignatureDefinition object to add.
+ /// Input the SignatureDefinition object to add.
///
/// \return
- /// Returns the position into which the new element was inserted.
+ /// Returns the position into which the new element was inserted.
///
System::Int32 Add(NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::SignatureDefinition *value);
/// \brief
- /// Determines the index of a specific SignatureDefinition object.
+ /// Determines the index of a specific SignatureDefinition object.
///
/// \param value
- /// Input the SignatureDefinition object to locate in the collection.
+ /// Input the SignatureDefinition object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::SignatureDefinition *value);
/// \brief
- /// Inserts a SignatureDefinition object into the collection at the specified position.
+ /// Inserts a SignatureDefinition object into the collection at the specified position.
///
/// \param index
- /// Input the zero-based index at which value should be inserted.
+ /// Input the zero-based index at which value should be inserted.
/// \param value
- /// Input the SignatureDefinition object to insert.
+ /// Input the SignatureDefinition object to insert.
///
System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::SignatureDefinition *value);
/// \brief
- /// Removes the first occurrence of a specific SignatureDefinition object.
+ /// Removes the first occurrence of a specific SignatureDefinition object.
///
/// \param value
- /// Input the SignatureDefinition object to remove from the collection.
+ /// Input the SignatureDefinition object to remove from the collection.
///
System::Void Remove(NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::SignatureDefinition *value);
/// \brief
- /// Determines whether the collection contains a specific SignatureDefinition object.
+ /// Determines whether the collection contains a specific SignatureDefinition object.
///
/// \param value
- /// Input The SignatureDefinition object to search in the collection.
+ /// Input The SignatureDefinition object to search in the collection.
///
/// \return
- /// Returns true if the value is found in the collection; otherwise, false.
+ /// Returns true if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::SignatureDefinition *value);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// 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.
+ /// 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.
+ /// Input an integer that represents the index in array at which copying begins.
///
System::Void CopyTo(NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::SignatureDefinition *array[], System::Int32 size);
-
/// \brief
- /// Gets or sets a SignatureDefinition in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the SignatureDefinition to retrieve or set (System::Int32).
+ /// 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 SignatureDefinition *get_RealTypeItem(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_RealTypeItem(System::Int32 index, NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::SignatureDefinition *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 SignatureDefinition *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, NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::SignatureDefinition *value);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
// -----------------------------------------------------------------------------------------------------
+/// \brief
+/// The ReadOnlySignatureDefinitionCollection class represents a collection of ReadOnlySignatureDefinition objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class ReadOnlySignatureDefinitionCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable,
public System::Collections::ICollection,
public System::Collections::IEnumerable
{
+/// \cond DOXYGEN-IGNORE
private:
/// \brief
- /// nested class defined to provide Enumerator.
+ /// 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
{
@@ -252,15 +361,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(ReadOnlySignatureDefinitionCollection *elements) : m_pCol(elements), m_nIdx(-1)
{
}
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
__property System::Object *get_Current();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first object 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 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();
};
@@ -280,31 +421,37 @@
ReadOnlySignatureDefinitionCollection();
/// \brief
- /// Gets the count of items in collection.
+ /// 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.
+ /// Gets an enumerator that can iterate through a collection.
///
+ /// \return
+ /// Returns an enumerator on the dictionary.
+ ///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// 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.
+ /// 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.
+ /// Input an integer that represents the index in array at which copying begins.
///
System::Void CopyTo(NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::SignatureDefinition *array[],
System::Int32 index);
/// \brief
- /// Determines the index of a specific SignatureDefinition object.
+ /// Determines the index of a specific SignatureDefinition object.
///
/// \param value
- /// Input the SignatureDefinition object to locate in the collection.
+ /// Input the SignatureDefinition object to locate in the collection.
///
/// \return
/// The index of value if found in the collection; otherwise, -1.
@@ -312,10 +459,10 @@
System::Int32 IndexOf(NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::SignatureDefinition *value);
/// \brief
- /// Determines whether the collection contains a specific SignatureDefinition object.
+ /// Determines whether the collection contains a specific SignatureDefinition object.
///
/// \param value
- /// Input The SignatureDefinition object to search in the collection.
+ /// Input The SignatureDefinition object to search in the collection.
///
/// \return
/// Returns true if the value is found in the collection; otherwise, false.
@@ -323,17 +470,32 @@
System::Boolean Contains(NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::SignatureDefinition *value);
/// \brief
- /// Gets or sets a SignatureDefinition in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the SignatureDefinition to retrieve or set (System::Int32).
+ /// 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 SignatureDefinition *get_RealTypeItem(System::Int32 index);
- __property SignatureDefinition *get_RealTypeItem(System::String* name);
+ /// \brief
+ /// Gets the item in the collection at the specified index.
+ ///
+ /// \param index
+ /// The name of the item in the collection.
+ ///
+ /// \return
+ /// Returns an instance of a the collected item.
+ ///
+__property SignatureDefinition *get_RealTypeItem(System::String* name);
+
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
-
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgThreadCapability.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgThreadCapability.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/Capabilities/mgThreadCapability.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -21,22 +21,22 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
/// \brief
-/// The FdoThreadCapability enumeration defines the threading capabilities of a feature provider.
-/// <param name="FdoThreadCapability_SingleThreaded">
+/// The ThreadCapability enumeration defines the threading capabilities of a feature provider.
+/// <param name="ThreadCapability_SingleThreaded">
/// The feature provider is not thread safe.
/// </param>
-/// <param name="FdoThreadCapability_PerConnectionThreaded">
+/// <param name="ThreadCapability_PerConnectionThreaded">
/// The feature provider supports a single thread per connection. Multiple concurrent threads
/// cannot access the same connection object and only one command can be executing per
/// connection. Multiple connections can be active concurrently as long as each is
/// executing on its own thread.
/// </param>
-/// <param name="FdoThreadCapability_PerCommandThreaded">
+/// <param name="ThreadCapability_PerCommandThreaded">
/// The feature provider supports a single thread per command. Multiple concurrent threads
/// cannot access the same command object, however multiple commands can be executing
/// concurrently against a single connection.
/// </param>
-/// <param name="FdoThreadCapability_MultiThreaded">
+/// <param name="ThreadCapability_MultiThreaded">
/// The feature provider is fully multi-threaded. Concurrent thread access is safe
/// for all objects.
/// </param>
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgConnectionState.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgConnectionState.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgConnectionState.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -21,18 +21,18 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS
/// \brief
-/// The FdoConnectionState enumeration indicates the current state of the connection
-/// <param name="FdoConnectionState_Busy">
+/// The ConnectionState enumeration indicates the current state of the connection
+/// <param name="ConnectionState_Busy">
/// The connection is busy executing one or more commands. Executing another
/// command while the connection is busy will result in an exception.
/// </param>
-/// <param name="FdoConnectionState_Closed">
+/// <param name="ConnectionState_Closed">
/// The connection is closed.
/// </param>
-/// <param name="FdoConnectionState_Open">
+/// <param name="ConnectionState_Open">
/// The connection is open.
/// </param>
-/// <param name="FdoConnectionState_Pending">
+/// <param name="ConnectionState_Pending">
/// The connection is pending. this is used to indicate that the application has
/// issued an Open request, but the open is not completed because the application needs to include additional connection property values.
/// </param>
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnection.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnection.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -53,14 +53,14 @@
public __gc __interface ITransaction;
/// \brief
-/// The FdoIConnection interface enables a feature provider to implement a
+/// The IConnection interface enables a feature provider to implement a
/// connection class, which represents a unique session with a data
/// store.
public __gc __interface IConnection : public System::IDisposable
{
public:
/// \brief
- /// Gets an FdoIConnectionCapabilities interface describing the capabilities
+ /// Gets an IConnectionCapabilities interface describing the capabilities
/// of the connection.
///
/// \return
@@ -69,7 +69,7 @@
__property NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::IConnectionCapabilities* get_ConnectionCapabilities();
/// \brief
- /// Gets an FdoISchemaCapabilities interface describing the provider's support for the feature schema.
+ /// Gets an ISchemaCapabilities interface describing the provider's support for the feature schema.
///
/// \return
/// Returns schema capabilities
@@ -77,7 +77,7 @@
__property NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::ISchemaCapabilities* get_SchemaCapabilities();
/// \brief
- /// Gets an FdoICommandCapabilities interface describing the commands a provider supports.
+ /// Gets an ICommandCapabilities interface describing the commands a provider supports.
///
/// \return
/// Returns the command capabilities
@@ -85,7 +85,7 @@
__property NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::ICommandCapabilities* get_CommandCapabilities();
/// \brief
- /// Gets an FdoIFilterCapabilities interface describing the provider's support for filters.
+ /// Gets an IFilterCapabilities interface describing the provider's support for filters.
///
/// \return
/// Returns the filter capabilities
@@ -93,7 +93,7 @@
__property NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::IFilterCapabilities* get_FilterCapabilities();
/// \brief
- /// Gets an FdoIExpressionCapabilities interface describing the provider's support for expressions.
+ /// Gets an IExpressionCapabilities interface describing the provider's support for expressions.
///
/// \return
/// Returns the expression capabilities
@@ -101,7 +101,7 @@
__property NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::IExpressionCapabilities* get_ExpressionCapabilities();
/// \brief
- /// Gets an FdoIRasterCapabilities interface describing the provider's support for raster images.
+ /// Gets an IRasterCapabilities interface describing the provider's support for raster images.
///
/// \return
/// Returns the raster capabilities
@@ -109,7 +109,7 @@
__property NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::IRasterCapabilities* get_RasterCapabilities();
/// \brief
- /// Gets an FdoITopologyCapabilities interface describing the provider's support for topology.
+ /// Gets an ITopologyCapabilities interface describing the provider's support for topology.
///
/// \return
/// Returns the topology capabilities
@@ -117,7 +117,7 @@
__property NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::ITopologyCapabilities* get_TopologyCapabilities();
/// \brief
- /// Gets an FdoIGeometryCapabilities interface describing the provider's support for geometry.
+ /// Gets an IGeometryCapabilities interface describing the provider's support for geometry.
///
/// \return
/// Returns the geometry capabilities
@@ -145,7 +145,7 @@
__property System::Void set_ConnectionString( System::String* value);
/// \brief
- /// Gets an FdoIConnectionInfo interface that can be used to interrogate and set connection properties.
+ /// Gets an IConnectionInfo interface that can be used to interrogate and set connection properties.
///
/// \return
/// Returns the connection info
@@ -204,7 +204,7 @@
/// \brief
/// Begins a transaction and returns an object that realizes
- /// FdoITransaction.
+ /// ITransaction.
///
/// \return
/// Returns the transaction
@@ -228,7 +228,7 @@
/// to this FDO Provider.
///
/// \return
- /// Returns FdoPhysicalSchemaMapping
+ /// Returns PhysicalSchemaMapping
///
NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping* CreateSchemaMapping();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionImp.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionImp.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -25,14 +25,14 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS
/// \brief
-/// The FdoIConnection interface enables a feature provider to implement a
+/// The IConnection interface enables a feature provider to implement a
/// connection class, which represents a unique session with a data
/// store.
public __gc class IConnectionImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_CONNECTIONS::IConnection
{
public:
/// \brief
- /// Gets an FdoIConnectionCapabilities interface describing the capabilities
+ /// Gets an IConnectionCapabilities interface describing the capabilities
/// of the connection.
///
/// \return
@@ -41,7 +41,7 @@
__property NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::IConnectionCapabilities* get_ConnectionCapabilities();
/// \brief
- /// Gets an FdoISchemaCapabilities interface describing the provider's support for the feature schema.
+ /// Gets an ISchemaCapabilities interface describing the provider's support for the feature schema.
///
/// \return
/// Returns schema capabilities
@@ -49,7 +49,7 @@
__property NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::ISchemaCapabilities* get_SchemaCapabilities();
/// \brief
- /// Gets an FdoICommandCapabilities interface describing the commands a provider supports.
+ /// Gets an ICommandCapabilities interface describing the commands a provider supports.
///
/// \return
/// Returns the command capabilities
@@ -57,7 +57,7 @@
__property NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::ICommandCapabilities* get_CommandCapabilities();
/// \brief
- /// Gets an FdoIFilterCapabilities interface describing the provider's support for filters.
+ /// Gets an IFilterCapabilities interface describing the provider's support for filters.
///
/// \return
/// Returns the filter capabilities
@@ -65,7 +65,7 @@
__property NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::IFilterCapabilities* get_FilterCapabilities();
/// \brief
- /// Gets an FdoIExpressionCapabilities interface describing the provider's support for expressions.
+ /// Gets an IExpressionCapabilities interface describing the provider's support for expressions.
///
/// \return
/// Returns the expression capabilities
@@ -73,7 +73,7 @@
__property NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::IExpressionCapabilities* get_ExpressionCapabilities();
/// \brief
- /// Gets an FdoIRasterCapabilities interface describing the provider's support for raster images.
+ /// Gets an IRasterCapabilities interface describing the provider's support for raster images.
///
/// \return
/// Returns the raster capabilities
@@ -81,7 +81,7 @@
__property NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::IRasterCapabilities* get_RasterCapabilities();
/// \brief
- /// Gets an FdoITopologyCapabilities interface describing the provider's support for topology.
+ /// Gets an ITopologyCapabilities interface describing the provider's support for topology.
///
/// \return
/// Returns the topology capabilities
@@ -89,7 +89,7 @@
__property NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::ITopologyCapabilities* get_TopologyCapabilities();
/// \brief
- /// Gets an FdoIGeometryCapabilities interface describing the provider's support for geometry.
+ /// Gets an IGeometryCapabilities interface describing the provider's support for geometry.
///
/// \return
/// Returns the geometry capabilities
@@ -117,7 +117,7 @@
__property System::Void set_ConnectionString( System::String* value);
/// \brief
- /// Gets an FdoIConnectionInfo interface that can be used to interrogate and set connection properties.
+ /// Gets an IConnectionInfo interface that can be used to interrogate and set connection properties.
///
/// \return
/// Returns the connection info
@@ -176,7 +176,7 @@
/// \brief
/// Begins a transaction and returns an object that realizes
- /// FdoITransaction.
+ /// ITransaction.
///
/// \return
/// Returns the transaction
@@ -200,7 +200,7 @@
/// to this FDO Provider.
///
/// \return
- /// Returns FdoPhysicalSchemaMapping
+ /// Returns PhysicalSchemaMapping
///
NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping* CreateSchemaMapping();
@@ -229,8 +229,10 @@
inline FdoIConnection* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_CONNECTIONS
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionInfo.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionInfo.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionInfo.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -25,8 +25,8 @@
public __gc __interface IConnectionPropertyDictionary;
/// \brief
-/// The FdoIConnectionInfo interface exposes information about the feature provider
-/// and provides access to the FdoIConnectionPropertyDictionary interface.
+/// The IConnectionInfo interface exposes information about the feature provider
+/// and provides access to the IConnectionPropertyDictionary interface.
public __gc __interface IConnectionInfo : public System::IDisposable
{
public:
@@ -71,7 +71,7 @@
__property System::String* get_FeatureDataObjectsVersion();
/// \brief
- /// Gets the FdoIConnectionPropertyDictionary interface that can be used to dynamically query and set the properties required to establish a connection.
+ /// Gets the IConnectionPropertyDictionary interface that can be used to dynamically query and set the properties required to establish a connection.
///
/// \return
/// Returns the property dictionary
@@ -81,9 +81,9 @@
/// \brief
/// Returns the provider type. A provider can be a file-based, database-based or
/// web-based provider. The valid values the function may return are defined in
- /// the enumeration FdoProviderDatastoreType. The enumeration includes the following
- /// values: FdoProviderDatastoreType_Unknown, FdoProviderDatastoreType_File,
- /// FdoProviderDatastoreType_DatabaseServer, FdoProviderDatastoreType_WebServer.
+ /// the enumeration ProviderDatastoreType. The enumeration includes the following
+ /// values: ProviderDatastoreType_Unknown, ProviderDatastoreType_File,
+ /// ProviderDatastoreType_DatabaseServer, ProviderDatastoreType_WebServer.
///
/// \return
/// Returns the provider data store type.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionInfoImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionInfoImp.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionInfoImp.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -25,8 +25,8 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS
/// \brief
-/// The FdoIConnectionInfo interface exposes information about the feature provider
-/// and provides access to the FdoIConnectionPropertyDictionary interface.
+/// The IConnectionInfo interface exposes information about the feature provider
+/// and provides access to the IConnectionPropertyDictionary interface.
private __gc class IConnectionInfoImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_CONNECTIONS::IConnectionInfo
{
public:
@@ -71,7 +71,7 @@
__property System::String* get_FeatureDataObjectsVersion();
/// \brief
- /// Gets the FdoIConnectionPropertyDictionary interface that can be used to dynamically query and set the properties required to establish a connection.
+ /// Gets the IConnectionPropertyDictionary interface that can be used to dynamically query and set the properties required to establish a connection.
///
/// \return
/// Returns the property dictionary
@@ -81,9 +81,9 @@
/// \brief
/// Returns the provider type. A provider can be a file-based, database-based or
/// web-based provider. The valid values the function may return are defined in
- /// the enumeration FdoProviderDatastoreType. The enumeration includes the following
- /// values: FdoProviderDatastoreType_Unknown, FdoProviderDatastoreType_File,
- /// FdoProviderDatastoreType_DatabaseServer, FdoProviderDatastoreType_WebServer.
+ /// the enumeration ProviderDatastoreType. The enumeration includes the following
+ /// values: ProviderDatastoreType_Unknown, ProviderDatastoreType_File,
+ /// ProviderDatastoreType_DatabaseServer, ProviderDatastoreType_WebServer.
///
/// \return
/// Returns the provider data store type.
@@ -106,8 +106,10 @@
inline FdoIConnectionInfo* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_CONNECTIONS
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionPropertyDictionary.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionPropertyDictionary.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionPropertyDictionary.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -21,7 +21,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS
/// \brief
-/// The FdoIConnectionPropertyDictionary exposes a dictionary style interface
+/// The IConnectionPropertyDictionary exposes a dictionary style interface
/// to the connection properties. The properties required to establish a connection
/// can be determined and their values can be set through this interface.
/// Modifying connection properties through this
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionPropertyDictionaryImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionPropertyDictionaryImp.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgIConnectionPropertyDictionaryImp.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -25,7 +25,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS
/// \brief
-/// The FdoIConnectionPropertyDictionary exposes a dictionary style interface
+/// The IConnectionPropertyDictionary exposes a dictionary style interface
/// to the connection properties. The properties required to establish a connection
/// can be determined and their values can be set through this interface.
/// Modifying connection properties through this
@@ -145,8 +145,10 @@
///
System::String* GetLocalizedName(System::String* name);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
IConnectionPropertyDictionaryImp(System::IntPtr unmanaged, System::Boolean autoDelete);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgITransaction.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgITransaction.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgITransaction.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -23,16 +23,16 @@
public __gc __interface IConnection;
/// \brief
-/// The FdoITransaction interface represents a transaction to be performed in a DataStore, and is implemented
+/// The ITransaction interface represents a transaction to be performed in a DataStore, and is implemented
/// by feature providers that support transactions.
public __gc __interface ITransaction : public System::IDisposable
{
public:
/// \brief
- /// Gets the FdoIConnection object associated with the transaction.
+ /// Gets the IConnection object associated with the transaction.
///
/// \return
- /// Returns FdoIConnection object
+ /// Returns IConnection object
///
__property NAMESPACE_OSGEO_FDO_CONNECTIONS::IConnection* get_Connection();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgITransactionImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgITransactionImp.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgITransactionImp.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -25,16 +25,16 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS
/// \brief
-/// The FdoITransaction interface represents a transaction to be performed in a DataStore, and is implemented
+/// The ITransaction interface represents a transaction to be performed in a DataStore, and is implemented
/// by feature providers that support transactions.
private __gc class ITransactionImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_CONNECTIONS::ITransaction
{
public:
/// \brief
- /// Gets the FdoIConnection object associated with the transaction.
+ /// Gets the IConnection object associated with the transaction.
///
/// \return
- /// Returns FdoIConnection object
+ /// Returns IConnection object
///
__property NAMESPACE_OSGEO_FDO_CONNECTIONS::IConnection* get_Connection();
@@ -59,8 +59,10 @@
inline FdoITransaction* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_CONNECTIONS
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgProviderDatastoreType.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgProviderDatastoreType.h 2007-02-02 01:01:05 UTC (rev 708)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Connections/mgProviderDatastoreType.h 2007-02-02 01:03:17 UTC (rev 709)
@@ -20,7 +20,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS
/// \brief
-/// The FdoProviderDatastoreType enumeration lists all of the concrete provider
+/// The ProviderDatastoreType enumeration lists all of the concrete provider
/// types supported by FDO.
/// <param name="ProviderDatastoreType_DatabaseServer">
/// Indicates that the provider is a database-based provider.
More information about the fdo-commits
mailing list