[fdo-commits] r704 - branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Thu Feb 1 19:18:52 EST 2007
Author: gregboone
Date: 2007-02-01 19:18:51 -0500 (Thu, 01 Feb 2007)
New Revision: 704
Modified:
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlClassMappingCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlElementMappingCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureFlags.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureHandler.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeaturePropertyReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeaturePropertyWriter.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureWriter.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFlags.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlNameCollectionHandler.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSchemaMapping.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSerializable.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextFlags.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextWriter.h
Log:
893057: DOC: FDO Managed API Documentation Updates
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlClassMappingCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlClassMappingCollection.h 2007-02-02 00:11:31 UTC (rev 703)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlClassMappingCollection.h 2007-02-02 00:18:51 UTC (rev 704)
@@ -32,9 +32,28 @@
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class XmlClassMappingCollection : 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
{
@@ -43,15 +62,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(XmlClassMappingCollection* 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();
};
@@ -64,57 +115,58 @@
inline FdoXmlClassMappingCollection* 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);
- __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);
-
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public:
/// \brief
- /// Constructs a new empty string collection
+ /// Constructs a new empty string collection
///
/// \return
- /// Returns StringCollection
+ /// Returns StringCollection
///
///
XmlClassMappingCollection(NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalElementMapping* parent);
/// \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 NAMESPACE_OSGEO_FDO_XML::XmlClassMapping from this collection.
+ /// Removes the index-th NAMESPACE_OSGEO_FDO_XML::XmlClassMapping from this collection.
///
/// \param index
/// Input index of the element to remove.
@@ -122,34 +174,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 NAMESPACE_OSGEO_FDO_XML::XmlClassMapping object into the collection.
+ /// Adds a NAMESPACE_OSGEO_FDO_XML::XmlClassMapping object into the collection.
///
/// \param value
/// Input the NAMESPACE_OSGEO_FDO_XML::XmlClassMapping 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_XML::XmlClassMapping* value);
/// \brief
- /// Determines the index of a specific NAMESPACE_OSGEO_FDO_XML::XmlClassMapping object.
+ /// Determines the index of a specific NAMESPACE_OSGEO_FDO_XML::XmlClassMapping object.
///
/// \param value
/// Input the NAMESPACE_OSGEO_FDO_XML::XmlClassMapping 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_XML::XmlClassMapping* value);
/// \brief
- /// Inserts a NAMESPACE_OSGEO_FDO_XML::XmlClassMapping object into the collection at the specified position.
+ /// Inserts a NAMESPACE_OSGEO_FDO_XML::XmlClassMapping object into the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
@@ -159,7 +211,7 @@
System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_FDO_XML::XmlClassMapping* value);
/// \brief
- /// Removes the first occurrence of a specific NAMESPACE_OSGEO_FDO_XML::XmlClassMapping object.
+ /// Removes the first occurrence of a specific NAMESPACE_OSGEO_FDO_XML::XmlClassMapping object.
///
/// \param value
/// Input the NAMESPACE_OSGEO_FDO_XML::XmlClassMapping object to remove from the collection.
@@ -167,18 +219,18 @@
System::Void Remove(NAMESPACE_OSGEO_FDO_XML::XmlClassMapping* value);
/// \brief
- /// Determines whether the collection contains a specific NAMESPACE_OSGEO_FDO_XML::XmlClassMapping object.
+ /// Determines whether the collection contains a specific NAMESPACE_OSGEO_FDO_XML::XmlClassMapping object.
///
/// \param value
/// Input The NAMESPACE_OSGEO_FDO_XML::XmlClassMapping 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_XML::XmlClassMapping* 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.
@@ -187,19 +239,49 @@
///
System::Void CopyTo(NAMESPACE_OSGEO_FDO_XML::XmlClassMapping* array[],System::Int32 size);
-
/// \brief
- /// Gets or sets a NAMESPACE_OSGEO_FDO_XML::XmlClassMapping in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the NAMESPACE_OSGEO_FDO_XML::XmlClassMapping 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 NAMESPACE_OSGEO_FDO_XML::XmlClassMapping* 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_XML::XmlClassMapping* 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 NAMESPACE_OSGEO_FDO_XML::XmlClassMapping* 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_XML::XmlClassMapping* value);
};
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlElementMappingCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlElementMappingCollection.h 2007-02-02 00:11:31 UTC (rev 703)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlElementMappingCollection.h 2007-02-02 00:18:51 UTC (rev 704)
@@ -32,9 +32,28 @@
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class XmlElementMappingCollection : 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
{
@@ -43,15 +62,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(XmlElementMappingCollection* 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();
};
@@ -64,57 +115,58 @@
inline FdoXmlElementMappingCollection* 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);
- __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);
-
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public:
/// \brief
- /// Constructs a new empty string collection
+ /// Constructs a new empty string collection
///
/// \return
- /// Returns StringCollection
+ /// Returns StringCollection
///
///
XmlElementMappingCollection(NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalElementMapping* parent);
/// \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 NAMESPACE_OSGEO_FDO_XML::XmlElementMapping from this collection.
+ /// Removes the index-th NAMESPACE_OSGEO_FDO_XML::XmlElementMapping from this collection.
///
/// \param index
/// Input index of the element to remove.
@@ -122,34 +174,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 NAMESPACE_OSGEO_FDO_XML::XmlElementMapping object into the collection.
+ /// Adds a NAMESPACE_OSGEO_FDO_XML::XmlElementMapping object into the collection.
///
/// \param value
/// Input the NAMESPACE_OSGEO_FDO_XML::XmlElementMapping 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_XML::XmlElementMapping* value);
/// \brief
- /// Determines the index of a specific NAMESPACE_OSGEO_FDO_XML::XmlElementMapping object.
+ /// Determines the index of a specific NAMESPACE_OSGEO_FDO_XML::XmlElementMapping object.
///
/// \param value
/// Input the NAMESPACE_OSGEO_FDO_XML::XmlElementMapping 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_XML::XmlElementMapping* value);
/// \brief
- /// Inserts a NAMESPACE_OSGEO_FDO_XML::XmlElementMapping object into the collection at the specified position.
+ /// Inserts a NAMESPACE_OSGEO_FDO_XML::XmlElementMapping object into the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
@@ -159,7 +211,7 @@
System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_FDO_XML::XmlElementMapping* value);
/// \brief
- /// Removes the first occurrence of a specific NAMESPACE_OSGEO_FDO_XML::XmlElementMapping object.
+ /// Removes the first occurrence of a specific NAMESPACE_OSGEO_FDO_XML::XmlElementMapping object.
///
/// \param value
/// Input the NAMESPACE_OSGEO_FDO_XML::XmlElementMapping object to remove from the collection.
@@ -167,18 +219,18 @@
System::Void Remove(NAMESPACE_OSGEO_FDO_XML::XmlElementMapping* value);
/// \brief
- /// Determines whether the collection contains a specific NAMESPACE_OSGEO_FDO_XML::XmlElementMapping object.
+ /// Determines whether the collection contains a specific NAMESPACE_OSGEO_FDO_XML::XmlElementMapping object.
///
/// \param value
/// Input The NAMESPACE_OSGEO_FDO_XML::XmlElementMapping 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_XML::XmlElementMapping* 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.
@@ -187,21 +239,60 @@
///
System::Void CopyTo(NAMESPACE_OSGEO_FDO_XML::XmlElementMapping* array[],System::Int32 size);
-
/// \brief
- /// Gets or sets a NAMESPACE_OSGEO_FDO_XML::XmlElementMapping in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the NAMESPACE_OSGEO_FDO_XML::XmlElementMapping 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 NAMESPACE_OSGEO_FDO_XML::XmlElementMapping* get_RealTypeItem(System::Int32 index);
+ /// \brief
+ /// Gets the item in the collection by name.
+ ///
+ /// \param index
+ /// The name of the item in the collection.
+ ///
+ /// \return
+ /// Returns an instance of a the collected item.
+ ///
__property NAMESPACE_OSGEO_FDO_XML::XmlElementMapping* get_RealTypeItem(System::String* index);
+ /// \brief
+ /// Sets the value of the item at the specified index
+ ///
+ /// \param index
+ /// Input index of the item to set.
+ ///
+ /// \param value
+ /// Input the value of the item
+ ///
__property System::Void set_RealTypeItem(System::Int32 index, NAMESPACE_OSGEO_FDO_XML::XmlElementMapping* 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 NAMESPACE_OSGEO_FDO_XML::XmlElementMapping* 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_XML::XmlElementMapping* value);
};
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureFlags.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureFlags.h 2007-02-02 00:11:31 UTC (rev 703)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureFlags.h 2007-02-02 00:18:51 UTC (rev 704)
@@ -33,23 +33,23 @@
/// If Document A is read into FDO and then written to Document B then the Error Levels
/// applied to the Document A read have the following meaning:
/// <ul>
-/// <li>ErrorLevel_High: Document B will be structurally identical to Document A.
-/// Errors are issued if this cannot be guaranteed. Document B will have the
-/// exact same elements and attributes as Document A.
-/// <li>ErrorLevel_Normal: There is no information loss. Document B contains
-/// all of the information from Document A and Document B conforms to Schema A.
-/// Errors are issued if this cannot be guaranteed.
-/// However, Documents A and B might not look exactly alike; some Document A elements
-/// may have an equivalent but different structure in Document B.
-/// <li>ErrorLevel_Low: There can be information loss. Document B is a subset
-/// of Document A but still conforms to Schema A. Errors are issued if
-/// this cannot be guaranteed. Any Document A elements, not recognized by
-/// FDO, are discarded on read.
-/// <li>ErrorLevel_VeryLow: FDO does a best effort read of Document A and write of
-/// Document B. There is no guarantee that Document B will look anything like
-/// Document A or that Document B will conform to Schema A.
+/// <li>ErrorLevel_High: Document B will be structurally identical to Document A.
+/// Errors are issued if this cannot be guaranteed. Document B will have the
+/// exact same elements and attributes as Document A.
+/// <li>ErrorLevel_Normal: There is no information loss. Document B contains
+/// all of the information from Document A and Document B conforms to Schema A.
+/// Errors are issued if this cannot be guaranteed.
+/// However, Documents A and B might not look exactly alike; some Document A elements
+/// may have an equivalent but different structure in Document B.
+/// <li>ErrorLevel_Low: There can be information loss. Document B is a subset
+/// of Document A but still conforms to Schema A. Errors are issued if
+/// this cannot be guaranteed. Any Document A elements, not recognized by
+/// FDO, are discarded on read.
+/// <li>ErrorLevel_VeryLow: FDO does a best effort read of Document A and write of
+/// Document B. There is no guarantee that Document B will look anything like
+/// Document A or that Document B will conform to Schema A.
/// </ul>
-///
+///
/// The above assumes that FDO is not provided the GML form of Schema A when writing
/// Document B. For example, supposed that FDO can write a Schema A conformant
/// Document B only when supplied the GML version of Schema A. FDO will still generate
@@ -311,8 +311,10 @@
inline FdoXmlFeatureFlags* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
virtual System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_XML
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureHandler.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureHandler.h 2007-02-02 00:11:31 UTC (rev 703)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureHandler.h 2007-02-02 00:18:51 UTC (rev 704)
@@ -437,14 +437,14 @@
/// referenced by the current association property:
/// <ul>
/// <li> if the associated feature is specified by an xlink:href, then
- /// the href value is sent through a single FeatureProperty event.
- /// The property is named "gml/id".
+ /// the href value is sent through a single FeatureProperty event.
+ /// The property is named "gml/id".
/// <li> if the associated feature is specified by its identity property
- /// values, then a FeatureProperty event is fired for each identity
- /// property value.
+ /// values, then a FeatureProperty event is fired for each identity
+ /// property value.
/// <li> if the associated feature is inline (specified by a sub-element of
- /// current association property) then a set of FeatureStart,
- /// FeatureProperty, and FeatureEnd events are fired.
+ /// current association property) then a set of FeatureStart,
+ /// FeatureProperty, and FeatureEnd events are fired.
/// </ul>
///
/// \param featureContext
@@ -523,8 +523,10 @@
inline FdoXmlFeatureHandler* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_XML
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeaturePropertyReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeaturePropertyReader.h 2007-02-02 00:11:31 UTC (rev 703)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeaturePropertyReader.h 2007-02-02 00:18:51 UTC (rev 704)
@@ -51,7 +51,7 @@
/// <li> GML FeatureCollection element
/// <li> the element specified by flags->collectionUri and flags->collectionName
/// <li> it has a corresponding class definition, in the given schemas, that
- /// derives from the GML AbstractFeatureCollectionType.
+ /// derives from the GML AbstractFeatureCollectionType.
/// </ul>
///
/// \param reader
@@ -69,7 +69,6 @@
/// Returns XmlFeaturePropertyReader
///
XmlFeaturePropertyReader(NAMESPACE_OSGEO_COMMON_XML::XmlReader* reader);
-
XmlFeaturePropertyReader(NAMESPACE_OSGEO_COMMON_XML::XmlReader* reader, NAMESPACE_OSGEO_FDO_XML::XmlFeatureFlags* flags);
/// \brief
@@ -98,9 +97,9 @@
/// in these schemas, is encountered then one of the following is done:
/// <ul>
/// <li> an exception is thrown when flags->errorLevel is Normal or higher. The
- /// exception reports all such features.
+ /// exception reports all such features.
/// <li> the feature is read according to a best default translation when the
- /// flags->errorLevel is below Normal.
+ /// flags->errorLevel is below Normal.
/// </ul>
///
/// \param schemas
@@ -130,11 +129,8 @@
/// Returns false if no feature(s) were read.
///
System::Boolean Parse();
-
System::Boolean Parse(NAMESPACE_OSGEO_FDO_XML::XmlFeatureHandler* featureHandler);
-
System::Boolean Parse(NAMESPACE_OSGEO_FDO_XML::XmlFeatureHandler* featureHandler, NAMESPACE_OSGEO_FDO_XML::XmlFeatureContext* featureContext);
-
System::Boolean Parse(NAMESPACE_OSGEO_FDO_XML::XmlFeatureHandler* featureHandler, NAMESPACE_OSGEO_FDO_XML::XmlFeatureContext* featureContext, System::Boolean incremental);
/// \brief
@@ -153,8 +149,10 @@
inline FdoXmlFeaturePropertyReader* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_XML
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeaturePropertyWriter.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeaturePropertyWriter.h 2007-02-02 00:11:31 UTC (rev 703)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeaturePropertyWriter.h 2007-02-02 00:18:51 UTC (rev 704)
@@ -259,8 +259,10 @@
inline FdoXmlFeaturePropertyWriter* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_XML
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureWriter.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureWriter.h 2007-02-02 00:11:31 UTC (rev 703)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureWriter.h 2007-02-02 00:18:51 UTC (rev 704)
@@ -41,11 +41,11 @@
/// written in GML format. Each feature is written in 3 steps:
/// <ol>
/// <li> call SetClassDefintion() to define the feature's class name,
-/// schema name, and list of valid properties.
+/// schema name, and list of valid properties.
/// <li> call SetProperty() for each feature property value to set.
/// <li> call WriteFeature() to write the feature with the current
-/// property values. The feature's element name is derived from the
-/// class and schema name.
+/// property values. The feature's element name is derived from the
+/// class and schema name.
/// </ol>
/// WriteFeature() ensures that the properties are written in their proper order. This
/// may have slight performance implications since this writer has to accumulate the
@@ -174,8 +174,10 @@
inline FdoXmlFeatureWriter* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
- System::Void ReleaseUnmanagedObject();
+ System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_XML
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFlags.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFlags.h 2007-02-02 00:11:31 UTC (rev 703)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFlags.h 2007-02-02 00:18:51 UTC (rev 704)
@@ -228,8 +228,10 @@
inline FdoXmlFlags* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
- System::Void ReleaseUnmanagedObject();
+ System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_XML
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlNameCollectionHandler.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlNameCollectionHandler.h 2007-02-02 00:11:31 UTC (rev 703)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlNameCollectionHandler.h 2007-02-02 00:18:51 UTC (rev 704)
@@ -23,7 +23,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_XML
/// \brief
-/// FdoXmlNameCollectionHandler is a class for serializing and
+/// XmlNameCollectionHandler is a class for serializing and
/// deserializing fdo:NameCollectionType elements.
public __gc class XmlNameCollectionHandler : public NAMESPACE_OSGEO_COMMON_XML::XmlSaxHandler
{
@@ -56,8 +56,10 @@
inline FdoXmlNameCollectionHandler* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_XML
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSchemaMapping.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSchemaMapping.h 2007-02-02 00:11:31 UTC (rev 703)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSchemaMapping.h 2007-02-02 00:18:51 UTC (rev 704)
@@ -28,7 +28,7 @@
public __gc class XmlClassMappingCollection;
/// \brief
-/// FdoXmlSchemaMapping specifies overrides for translating a feature schema between
+/// XmlSchemaMapping specifies overrides for translating a feature schema between
/// FDO and GML.
public __gc class XmlSchemaMapping : public NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping
{
@@ -65,15 +65,15 @@
/// Gets the mappings between GML global elements and their types as Fdo Classes. These
/// mappings are used in two circumstances:
/// <ul>
- /// <li> when features are read from a GML Document, these mappings determine the Feature
- /// class of each feature, based on its element name. If the element name is not
- /// in these mappings then the class name defaults to the element name.
- /// <li> when the Feature Schema for these overrides is written to GML, a global element
- /// is created from each item in element mappings collection.
+ /// <li> when features are read from a GML Document, these mappings determine the Feature
+ /// class of each feature, based on its element name. If the element name is not
+ /// in these mappings then the class name defaults to the element name.
+ /// <li> when the Feature Schema for these overrides is written to GML, a global element
+ /// is created from each item in element mappings collection.
/// </ul>
///
/// \return
- /// Returns FdoXmlElementMappingCollection*
+ /// Returns XmlElementMappingCollection
///
NAMESPACE_OSGEO_FDO_XML::XmlElementMappingCollection* GetElementMappings();
@@ -81,7 +81,7 @@
/// Gets the mappings for FDO Classes.
///
/// \return
- /// Returns FdoXmlClassMappingCollection*
+ /// Returns XmlClassMappingCollection
///
NAMESPACE_OSGEO_FDO_XML::XmlClassMappingCollection* GetClassMappings();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSerializable.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSerializable.h 2007-02-02 00:11:31 UTC (rev 703)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSerializable.h 2007-02-02 00:18:51 UTC (rev 704)
@@ -26,9 +26,9 @@
public __gc class XmlFlags;
/// \brief
-/// FdoXmlSerializable provides the ability to serialize an FDO object
+/// XmlSerializable provides the ability to serialize an FDO object
/// to an XML Document. Serialization support can be added to any class by basing
-/// it on FdoXmlSerializable and implementing the _writeXml callback.
+/// it on XmlSerializable and implementing the _writeXml callback.
public __gc class XmlSerializable : public NAMESPACE_OSGEO_RUNTIME:: Disposable, public NAMESPACE_OSGEO_FDO_XML::IXmlSerializable
{
public:
@@ -40,7 +40,7 @@
/// Input the file name.
/// \param flags
/// Input controls the writing of the elements to the document.
- /// If NULL then the default flags are used (see FdoXmlFlags::Create())
+ /// If NULL then the default flags are used (see XmlFlags::Create())
///
System::Void WriteXml(String* fileName);
@@ -56,7 +56,7 @@
/// XML writer's current position will be just after this object.
/// \param flags
/// Input controls the writing of the elements to the writer.
- /// If NULL then the default flags are used (see FdoXmlFlags::Create())
+ /// If NULL then the default flags are used (see XmlFlags::Create())
///
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* xmlWriter);
@@ -71,7 +71,7 @@
/// text writer's current position will be just after this object.
/// \param flags
/// Input controls the writing of the elements to the writer.
- /// If NULL then the default flags are used (see FdoXmlFlags::Create())
+ /// If NULL then the default flags are used (see XmlFlags::Create())
///
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* textWriter);
@@ -86,7 +86,7 @@
/// stream's current position will be just after this object.
/// \param flags
/// Input controls the writing of the elements to the stream.
- /// If NULL then the default flags are used (see FdoXmlFlags::Create())
+ /// If NULL then the default flags are used (see XmlFlags::Create())
///
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
@@ -94,7 +94,7 @@
/// \brief
/// Gets the stylesheet for converting the XML document from
- /// internal to external format. When classes derived from FdoXmlSerializable
+ /// internal to external format. When classes derived from XmlSerializable
/// define an internal format, they must override this function to return a
/// stylesheet that does the conversion.
///
@@ -108,8 +108,10 @@
inline FdoXmlSerializable* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_XML
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextFlags.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextFlags.h 2007-02-02 00:11:31 UTC (rev 703)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextFlags.h 2007-02-02 00:18:51 UTC (rev 704)
@@ -28,7 +28,7 @@
{
public:
/// \brief
- /// The FdoXmlSpatialContextFlags::ConflictOption specifies how
+ /// XmlSpatialContextFlags::ConflictOption specifies how
/// to handle Spatial Contexts that are already in the DataStore,
/// when Deserializing:
///
@@ -51,7 +51,7 @@
};
/// \brief
- /// Constructs an FdoXmlSpatialContextFlags object.
+ /// Constructs an XmlSpatialContextFlags object.
///
/// \param location
/// Base URL for generating well-known references to
@@ -64,7 +64,7 @@
/// false: apply name adjustment only to elements with fdo:nameAdjust="true"
/// \param conflictOption
/// Input option for Deserializing Spatial Contexts.
- /// Specified how Spatial Contexts, already in the FDO connection, are handled.
+ /// Specified how Spatial Contexts, already in connection, are handled.
/// \param includeDefault
/// Input true: When Serializing Spatial Contexts, serialize
/// all contexts including the default.
@@ -119,6 +119,16 @@
///
__property System::Boolean get_IncludeDefault();
+ /// \brief
+ /// Constructs a XmlSpatialContextFlags object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
XmlSpatialContextFlags(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_XML::XmlFlags(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextReader.h 2007-02-02 00:11:31 UTC (rev 703)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextReader.h 2007-02-02 00:18:51 UTC (rev 704)
@@ -27,10 +27,10 @@
public __gc class XmlSpatialContextFlags;
/// \brief
-/// FdoXmlSpatialContextReader reads Spatial Contexts from an XML
+/// XmlSpatialContextReader reads Spatial Contexts from an XML
/// document. Unlike other XML Readers, the reading is done procedurally,
-/// rather than through events. FdoXmlSpatialContextReader implements
-/// FdoISpatialContextReader to provide the functions for retrieving the
+/// rather than through events. XmlSpatialContextReader implements
+/// ISpatialContextReader to provide the functions for retrieving the
/// spatial contexts that were read.
public __gc class XmlSpatialContextReader : public NAMESPACE_OSGEO_COMMON_XML::XmlSaxHandler, public NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT::ISpatialContextReader
{
@@ -58,7 +58,7 @@
///
NAMESPACE_OSGEO_COMMON_XML::XmlReader* GetXmlReader();
- /// FdoISpatialContextReader implementation
+ /// ISpatialContextReader implementation
/// \brief
/// Gets the name of the spatial context currently being read.
@@ -169,8 +169,10 @@
inline FdoXmlSpatialContextReader* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_XML
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextWriter.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextWriter.h 2007-02-02 00:11:31 UTC (rev 703)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextWriter.h 2007-02-02 00:18:51 UTC (rev 704)
@@ -26,7 +26,7 @@
public __gc class XmlSpatialContextFlags;
/// \brief
-/// FdoXmlSpatialContextWriter writes Spatial Contexts to an
+/// XmlSpatialContextWriter writes Spatial Contexts to an
/// XML document. This is done by calling the various setter functions
/// to set the spatial context attributes and then calling
/// WriteSpatialContext() to write the spatial context using the current
@@ -46,7 +46,7 @@
/// default flags are used.
///
/// \return
- /// Returns FdoXmlSpatialContextWriter
+ /// Returns XmlSpatialContextWriter
///
XmlSpatialContextWriter(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* writer);
@@ -237,8 +237,10 @@
inline FdoXmlSpatialContextWriter* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_XML
More information about the fdo-commits
mailing list