[fdo-commits] r705 - branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Thu Feb 1 19:39:41 EST 2007
Author: gregboone
Date: 2007-02-01 19:39:40 -0500 (Thu, 01 Feb 2007)
New Revision: 705
Modified:
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgAssociationPropertyDefinition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClass.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassCapabilities.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassDefinition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassType.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDataPropertyDefinition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDataPropertyDefinitionCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDataType.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDeleteRule.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureClass.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureClassCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureSchema.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureSchemaCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgGeometricPropertyDefinition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkClass.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkFeatureClass.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkLayerClass.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkLinkFeatureClass.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkNodeFeatureClass.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgObjectPropertyDefinition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgObjectType.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgOrderType.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyDefinition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyDefinitionCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyType.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyValueConstraint.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyValueConstraintList.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyValueConstraintRange.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgRasterPropertyDefinition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgReadOnlyDataPropertyDefinitionCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgReadOnlyPropertyDefinitionCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgSchemaAttributeDictionary.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgSchemaElement.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgSchemaElementState.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgTopoFeaturePropertyDefinition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgTopoGeometryPropertyDefinition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgTopology.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgUniqueConstraint.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgUniqueConstraintCollection.h
Log:
893057: DOC: FDO Managed API Documentation Updates
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgAssociationPropertyDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgAssociationPropertyDefinition.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgAssociationPropertyDefinition.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -30,7 +30,7 @@
public __gc class ClassDefinition;
/// \brief
-/// The FdoAssociationPropertyDefinition class derives from FdoPropertyDefinition and represents
+/// AssociationPropertyDefinition class derives PropertyDefinition and represents
/// the association between two classes.
/// The class of the associated class must already be defined in the feature
/// schema and cannot be abstract.
@@ -38,12 +38,12 @@
{
public:
/// \brief
- /// Constructs a default instance of an FdoAssociationPropertyDefinition.
+ /// Constructs a default instance of an AssociationPropertyDefinition.
///
AssociationPropertyDefinition();
/// \brief
- /// Constructs an instance of an FdoAssociationPropertyDefinition using the specified
+ /// Constructs an instance of an AssociationPropertyDefinition using the specified
/// arguments.
///
/// \param name
@@ -55,7 +55,7 @@
/// <p><b>Note:</b> A client would never set system to true, only a provider.
///
/// \return
- /// Returns FdoAssociationPropertyDefinition
+ /// Returns AssociationPropertyDefinition
///
AssociationPropertyDefinition(System::String* name, System::String* description);
@@ -252,6 +252,16 @@
///
__property System::Void set_ReverseMultiplicity(System::String* value);
+ /// \brief
+ /// Constructs a AssociationPropertyDefinition 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.
+ ///
AssociationPropertyDefinition(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_SCHEMA::PropertyDefinition(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClass.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClass.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClass.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -27,7 +27,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// The FdoClass class derives from FdoClassDefinition and can be used to represent any type of
+/// Class derives ClassDefinition and can be used to represent any type of
/// non-spatial data within a feature schema. Typically, classes are used in the
/// feature schema to define complex properties of other feature types by
/// containment. However, they can also be used at global scope and
@@ -37,31 +37,41 @@
{
public:
/// \brief
- /// Constructs a default instance of an FdoClass.
+ /// Constructs a default instance of an Class.
///
Class();
/// \brief
- /// Constructs an instance of an FdoClass using the specified arguments.
+ /// Constructs an instance of an FDO Class using the specified arguments.
///
/// \param name
- /// Input name
+ /// Input the name of the class
/// \param description
- /// Input description
+ /// Input the description of the class
///
/// \return
- /// Returns FdoClass
+ /// Returns an FDO Class
///
Class(System::String* name, System::String* description);
/// \brief
- /// Gets the concrete class type.
+ /// Gets the concrete FDO class type.
///
/// \return
- /// Returns class type
+ /// Returns the FDO class type
///
__property NAMESPACE_OSGEO_FDO_SCHEMA::ClassType get_ClassType();
+ /// \brief
+ /// Constructs an FDO Class 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.
+ ///
Class(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassCapabilities.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassCapabilities.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassCapabilities.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -31,17 +31,17 @@
public __gc class ClassDefinition;
/// \brief
-/// The FdoClassCapabilites class describes various capabilities
+/// The ClassCapabilites class describes various capabilities
/// for a particular FDO Class Definition and an FDO Provider datastore.
public __gc class ClassCapabilities : public NAMESPACE_OSGEO_RUNTIME::Disposable
{
public:
/// \brief
- /// Constructs an FdoClassCapabilities instance. This function
+ /// Constructs an ClassCapabilities instance. This function
/// should only be called from an FDO Provider.
///
/// \param parent
- /// Input The Fdo Class Definition that owns these
+ /// Input The FDO Class Definition that owns these
/// capabilities.
///
ClassCapabilities(NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition* parent);
@@ -64,7 +64,7 @@
__property System::Void set_SupportsLocking(System::Boolean value);
/// \brief
- /// Gets an array of the FdoLockType values supported by the feature provider.
+ /// Gets an array of LockType values supported by the feature provider.
///
/// \param size
/// Output the number of lock types
@@ -107,7 +107,7 @@
/// Gets the parent of this Class Capabilites object.
///
/// \return
- /// Returns FdoClassDefinition
+ /// Returns ClassDefinition
///
__property NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition* get_Parent();
@@ -121,8 +121,10 @@
inline FdoClassCapabilities* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
private:
typedef FdoArray<FdoLockType> FdoLockTypeArray;
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassCollection.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassCollection.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -25,13 +25,32 @@
public __gc class SchemaElement;
/// \brief
-/// The FdoClassCollection class represents a collection of FdoClassDefinition objects.
+/// The ClassCollection class represents a collection of ClassDefinition objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class ClassCollection : 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
{
@@ -40,15 +59,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(ClassCollection* 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();
};
@@ -56,55 +107,72 @@
inline FdoClassCollection* 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 ClassCollection object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the parent schema object of the collection
+ ///
ClassCollection(NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement* parent);
+ /// \brief
+ /// Constructs a ClassCollection 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.
+ ///
ClassCollection(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
{
}
/// \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 ClassDefinition from this collection.
+ /// Removes the index-th ClassDefinition from this collection.
///
/// \param index
/// Input index of the element to remove.
@@ -112,36 +180,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 ClassDefinition object into the collection.
+ /// Adds a ClassDefinition object into the collection.
///
/// \param value
/// Input the ClassDefinition 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(ClassDefinition* value);
/// \brief
- /// Determines the index of a specific ClassDefinition object.
+ /// Determines the index of a specific ClassDefinition object.
///
/// \param value
/// Input the ClassDefinition 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(ClassDefinition* value);
System::Int32 IndexOf(String* name);
/// \brief
- /// Inserts a ClassDefinition object into the collection at the specified position.
+ /// Inserts a ClassDefinition object into the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
@@ -151,7 +219,7 @@
System::Void Insert(System::Int32 index, ClassDefinition* value);
/// \brief
- /// Removes the first occurrence of a specific ClassDefinition object.
+ /// Removes the first occurrence of a specific ClassDefinition object.
///
/// \param value
/// Input the ClassDefinition object to remove from the collection.
@@ -159,20 +227,29 @@
System::Void Remove(ClassDefinition* value);
/// \brief
- /// Determines whether the collection contains a specific ClassDefinition object.
+ /// Determines whether the collection contains a specific ClassDefinition object.
///
/// \param value
/// Input The ClassDefinition 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(ClassDefinition* value);
+ /// \brief
+ /// Determines whether the collection contains a specific ClassDefinition object.
+ ///
+ /// \param value
+ /// Input The name of the ClassDefinition object to search in the collection.
+ ///
+ /// \return
+ /// Returns true if the value is found in the collection; otherwise, false.
+ ///
System::Boolean Contains(String* name);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// 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.
@@ -181,21 +258,60 @@
///
System::Void CopyTo(ClassDefinition* array[],System::Int32 size);
-
/// \brief
- /// Gets or sets a ClassDefinition in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the ClassDefinition 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 ClassDefinition* 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 ClassDefinition* 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, ClassDefinition* 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 ClassDefinition* 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, ClassDefinition* value);
};
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassDefinition.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassDefinition.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -32,9 +32,9 @@
public __gc class ClassCapabilities;
/// \brief
-/// FdoClassDefinition is an abstract class that derives from FdoSchemaElement.
-/// FdoClassDefinition is a base class for all concrete class types (e.g., FdoClass,
-/// FdoFeatureClass) in the Schema package.
+/// ClassDefinition is an abstract class that derives from SchemaElement.
+/// ClassDefinition is a base class for all concrete class types (e.g., FdoClass,
+/// FeatureClass) in the Schema package.
public __gc class ClassDefinition : public NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement
{
public:
@@ -43,23 +43,23 @@
/// the concrete class type.
///
/// \return
- /// Returns FdoClassType
+ /// Returns the ClassType
///
__property NAMESPACE_OSGEO_FDO_SCHEMA::ClassType get_ClassType();
/// \brief
- /// Gets the base FdoClassDefinition this class is derived from.
+ /// Gets the base ClassDefinition this class is derived from.
///
/// \return
- /// Returns the base FdoClassDefinition
+ /// Returns the base ClassDefinition
///
__property NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition* get_BaseClass();
/// \brief
- /// Sets the base FdoClassDefinition this class is derived from.
+ /// Sets the base ClassDefinition this class is derived from.
///
/// \param value
- /// Input FdoClassDefinition this class is derived from
+ /// Input ClassDefinition this class is derived from
///
/// \return
/// Returns nothing
@@ -67,17 +67,17 @@
__property System::Void set_BaseClass(NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition* value);
/// \brief
- /// Gets the abstraction state of the FdoClassDefinition. Classes marked as abstract
+ /// Gets the abstraction state of ClassDefinition. Classes marked as abstract
/// cannot be created via FDO commands and cannot be used as properties of
/// another class.
///
/// \return
- /// Returns if the FdoClassDefinition is abstract
+ /// Returns true if the ClassDefinition is abstract
///
__property System::Boolean get_IsAbstract();
/// \brief
- /// Sets the abstraction state of the FdoClassDefinition. Classes marked as abstract
+ /// Sets the abstraction state of ClassDefinition. Classes marked as abstract
/// cannot be created via FDO commands and cannot be used as properties of
/// another class.
///
@@ -94,7 +94,7 @@
/// input collection must also be properties of the class.
///
/// \param value
- /// Input collection of FdoPropertyDefinition values
+ /// Input collection of PropertyDefinition values
///
/// \return
/// Returns nothing
@@ -105,18 +105,18 @@
System::Void SetBaseProperties(NAMESPACE_OSGEO_FDO_SCHEMA::PropertyDefinitionCollection* value);
/// \brief
- /// Returns an FdoReadOnlyPropertyDefinitionCollection containing the properties
+ /// Returns an ReadOnlyPropertyDefinitionCollection containing the properties
/// defined by base classes or by the concrete class type, itself. This
- /// collection is only populated when the FdoClassDefinition is returned by the
+ /// collection is only populated when ClassDefinition is returned by the
/// DescribeSchema command.
///
/// \return
- /// Returns FdoReadOnlyPropertyDefinitionCollection
+ /// Returns ReadOnlyPropertyDefinitionCollection
///
NAMESPACE_OSGEO_FDO_SCHEMA::ReadOnlyPropertyDefinitionCollection* GetBaseProperties();
/// \brief
- /// Returns an FdoDataPropertyDefinitionCollection containing references to the
+ /// Returns an DataPropertyDefinitionCollection containing references to the
/// data properties that can be used to uniquely identify instances of the
/// class. The contained properties must already be defined in either the
/// properties or baseProperties collection. If GetBaseClass() returns non
@@ -128,7 +128,7 @@
__property NAMESPACE_OSGEO_FDO_SCHEMA::DataPropertyDefinitionCollection* get_IdentityProperties();
/// \brief
- /// Returns an FdoReadOnlyDataPropertyDefinitionCollection containing the identity
+ /// Returns an ReadOnlyDataPropertyDefinitionCollection containing the identity
/// properties for the base class.
///
/// \return
@@ -137,11 +137,11 @@
__property NAMESPACE_OSGEO_FDO_SCHEMA::ReadOnlyDataPropertyDefinitionCollection* get_BaseIdentityProperties();
/// \brief
- /// Returns an FdoPropertyCollection containing the FdoDataProperties,
- /// FdoClassProperties, and FdoGeometricProperties defined for this class.
+ /// Returns an PropertyCollection containing DataProperties,
+ /// ClassProperties, and GeometricProperties defined for this class.
///
/// \return
- /// Returns FdoPropertyDefinitionCollection
+ /// Returns PropertyDefinitionCollection
///
__property NAMESPACE_OSGEO_FDO_SCHEMA::PropertyDefinitionCollection* get_Properties();
@@ -154,17 +154,17 @@
__property System::String* get_QualifiedName();
/// \brief
- /// Gets the computed state of the FdoClassDefinition. Computed classes cannot be made persistent or added to
+ /// Gets the computed state of ClassDefinition. Computed classes cannot be made persistent or added to
/// FDO schema. The computed classes are used as a transient classes that can be returned by a feature or data reader.
/// They describe the result of a select expression, select function and select distinct.
///
/// \return
- /// Returns if the FdoClassDefinition is a computed class
+ /// Returns true if the ClassDefinition is a computed class
///
__property System::Boolean get_IsComputed();
/// \brief
- /// Sets the computed state of the FdoClassDefinition. This is an internal method that
+ /// Sets the computed state of ClassDefinition. This is an internal method that
/// can only be called by providers. Application should not use this method.
///
/// \param value
@@ -198,15 +198,25 @@
__property System::Void set_Capabilities(NAMESPACE_OSGEO_FDO_SCHEMA::ClassCapabilities* value);
/// \brief
- /// Gets a FdoUniqueConstraintCollection containing all unique constraints applied to properties of this class.
+ /// Gets a UniqueConstraintCollection containing all unique constraints applied to properties of this class.
/// The contained properties must already be defined in either the
/// properties or baseProperties collections.
///
/// \return
- /// A FdoUniqueConstraintCollection containing all unique constraints defined for properties of this class.
+ /// A UniqueConstraintCollection containing all unique constraints defined for properties of this class.
///
__property NAMESPACE_OSGEO_FDO_SCHEMA::UniqueConstraintCollection* get_UniqueConstraints();
+ /// \brief
+ /// Constructs a ClassDefinition 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.
+ ///
ClassDefinition(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassType.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassType.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassType.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -21,24 +21,24 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// The FdoClassType enumeration lists all of the concrete class types defined in
+/// The ClassType enumeration lists all of the concrete class types defined in
/// the Schema package.
-/// <param name="FdoClassType_Class">
+/// <param name="ClassType_Class">
/// Represents the concrete class type Class
/// </param>
-/// <param name="FdoClassType_FeatureClass">
+/// <param name="ClassType_FeatureClass">
/// Represents the concrete class type FeatureClass
/// </param>
-/// <param name="FdoClassType_NetworkClass">
+/// <param name="ClassType_NetworkClass">
/// Represents the concrete class type NetworkClass
/// </param>
-/// <param name="FdoClassType_NetworkLayerClass">
+/// <param name="ClassType_NetworkLayerClass">
/// Represents the concrete class type NetworkLayerClass
/// </param>
-/// <param name="FdoClassType_NetworkNodeClass">
+/// <param name="ClassType_NetworkNodeClass">
/// Represents the concrete class type NetworkNodeClass
/// </param>
-/// <param name="FdoClassType_NetworkLinkClass">
+/// <param name="ClassType_NetworkLinkClass">
/// Represents the concrete class type NetworkLinkClass
/// </param>
public __value enum ClassType
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDataPropertyDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDataPropertyDefinition.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDataPropertyDefinition.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -26,19 +26,19 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// The FdoDataPropertyDefinition class derives from FdoPropertyDefinition and represents simple
-/// values or collections of simple values. FdoDataPropertyDefinitions can take on
-/// any of the data types listed in the FdoDataType enumeration.
+/// The DataPropertyDefinition class derives PropertyDefinition and represents simple
+/// values or collections of simple values. DataPropertyDefinitions can take on
+/// any of the data types listed in DataType enumeration.
public __gc class DataPropertyDefinition : public NAMESPACE_OSGEO_FDO_SCHEMA::PropertyDefinition
{
public:
/// \brief
- /// Constructs a default instance of an FdoDataPropertyDefinition.
+ /// Constructs a default instance of an DataPropertyDefinition.
///
DataPropertyDefinition();
/// \brief
- /// Constructs an instance of an FdoDataPropertyDefinition using the specified arguments
+ /// Constructs an instance of an DataPropertyDefinition using the specified arguments
///
/// \param name
/// Input name
@@ -58,18 +58,18 @@
__property NAMESPACE_OSGEO_FDO_SCHEMA::PropertyType get_PropertyType();
/// \brief
- /// Gets the FdoDataType of this property.
+ /// Gets the DataType of this property.
///
/// \return
- /// Returns FdoDataType of this property
+ /// Returns the DataType of this property
///
__property NAMESPACE_OSGEO_FDO_SCHEMA::DataType get_DataType();
/// \brief
- /// Sets the FdoDataType of this property.
+ /// Sets the DataType of this property.
///
/// \param dataType
- /// Input the FdoDataType of this property
+ /// Input the DataType of this property
///
/// \return
/// Returns nothing
@@ -97,7 +97,7 @@
/// \brief
/// Gets the length of a String, BLOB, or CLOB data property. This value
- /// does not apply to any other FdoDataType.
+ /// does not apply to any other DataType.
///
/// \return
/// Returns the length of a String, BLOB, or CLOB data property
@@ -106,7 +106,7 @@
/// \brief
/// Sets the length of a String, BLOB, or CLOB data property. This value is
- /// ignored for all other FdoDataType values.
+ /// ignored for all other DataType values.
///
/// \param value
/// Input the length of a String, BLOB, or CLOB data property
@@ -118,7 +118,7 @@
/// \brief
/// Gets the precision (total number of digits) of a decimal data property.
- /// This value does not apply to any other FdoDataType.
+ /// This value does not apply to any other DataType.
///
/// \return
/// Returns the precision
@@ -127,7 +127,7 @@
/// \brief
/// Sets the precision (total number of digits) of a decimal data property.
- /// This value is ignored for all other FdoDataType values.
+ /// This value is ignored for all other DataType values.
///
/// \param value
/// Input the precision
@@ -139,7 +139,7 @@
/// \brief
/// Gets the scale (number of digits to the right of the decimal point) of a
- /// decimal data property. This value does not apply to any other FdoDataType.
+ /// decimal data property. This value does not apply to any other DataType.
///
/// \return
/// Returns the scale
@@ -148,7 +148,7 @@
/// \brief
/// Sets the scale (number of digits to the right of the decimal point) of a
- /// decimal data property. This value is ignored for all other FdoDataType values.
+ /// decimal data property. This value is ignored for all other DataType values.
///
/// \param value
/// Input the scale
@@ -232,7 +232,7 @@
/// Returns the value constraint of this data property.
///
/// \return
- /// Returns the FdoPropertyValueConstraint or NULL if not set.
+ /// Returns PropertyValueConstraint or NULL if not set.
///
__property NAMESPACE_OSGEO_FDO_SCHEMA::PropertyValueConstraint* get_ValueConstraint();
@@ -247,6 +247,16 @@
///
__property System::Void set_ValueConstraint(NAMESPACE_OSGEO_FDO_SCHEMA::PropertyValueConstraint* value );
+ /// \brief
+ /// Constructs a DataPropertyDefinition 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.
+ ///
DataPropertyDefinition(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_SCHEMA::PropertyDefinition(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDataPropertyDefinitionCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDataPropertyDefinitionCollection.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDataPropertyDefinitionCollection.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -25,13 +25,32 @@
public __gc class SchemaElement;
/// \brief
-/// The FdoDataPropertyDefinitionCollection class represents a collection of FdoDataPropertyDefinition objects.
+/// The DataPropertyDefinitionCollection class represents a collection of DataPropertyDefinition objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class DataPropertyDefinitionCollection : 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
{
@@ -40,15 +59,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(DataPropertyDefinitionCollection* 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();
};
@@ -56,55 +107,72 @@
inline FdoDataPropertyDefinitionCollection* 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 DataPropertyDefinitionCollection object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the parent schema object of the collection
+ ///
DataPropertyDefinitionCollection(NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement* parent);
+ /// \brief
+ /// Constructs a DataPropertyDefinitionCollection 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.
+ ///
DataPropertyDefinitionCollection(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
{
}
/// \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 DataPropertyDefinition from this collection.
+ /// Removes the index-th DataPropertyDefinition from this collection.
///
/// \param index
/// Input index of the element to remove.
@@ -112,36 +180,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 DataPropertyDefinition object into the collection.
+ /// Adds a DataPropertyDefinition object into the collection.
///
/// \param value
/// Input the DataPropertyDefinition 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(DataPropertyDefinition* value);
/// \brief
- /// Determines the index of a specific DataPropertyDefinition object.
+ /// Determines the index of a specific DataPropertyDefinition object.
///
/// \param value
/// Input the DataPropertyDefinition 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(DataPropertyDefinition* value);
System::Int32 IndexOf(String* name);
/// \brief
- /// Inserts a DataPropertyDefinition object into the collection at the specified position.
+ /// Inserts a DataPropertyDefinition object into the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
@@ -151,7 +219,7 @@
System::Void Insert(System::Int32 index, DataPropertyDefinition* value);
/// \brief
- /// Removes the first occurrence of a specific DataPropertyDefinition object.
+ /// Removes the first occurrence of a specific DataPropertyDefinition object.
///
/// \param value
/// Input the DataPropertyDefinition object to remove from the collection.
@@ -159,20 +227,29 @@
System::Void Remove(DataPropertyDefinition* value);
/// \brief
- /// Determines whether the collection contains a specific DataPropertyDefinition object.
+ /// Determines whether the collection contains a specific DataPropertyDefinition object.
///
/// \param value
/// Input The DataPropertyDefinition 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(DataPropertyDefinition* value);
+ /// \brief
+ /// Determines whether the collection contains a specific DataPropertyDefinition object.
+ ///
+ /// \param value
+ /// Input The name of the DataPropertyDefinition object to search in the collection.
+ ///
+ /// \return
+ /// Returns true if the value is found in the collection; otherwise, false.
+ ///
System::Boolean Contains(String* name);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// 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.
@@ -181,21 +258,60 @@
///
System::Void CopyTo(DataPropertyDefinition* array[],System::Int32 size);
-
/// \brief
- /// Gets or sets a DataPropertyDefinition in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the DataPropertyDefinition 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 DataPropertyDefinition* 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 DataPropertyDefinition* 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, DataPropertyDefinition* 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 DataPropertyDefinition* 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, DataPropertyDefinition* value);
};
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDataType.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDataType.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDataType.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -21,33 +21,33 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// The FdoDataType enumeration lists all of the base data types supported by FDO.
-/// \param FdoDataType_Boolean
+/// The DataType enumeration lists all of the base data types supported by FDO.
+/// \param DataType_Boolean
/// Represents a Boolean value of true or false
-/// \param FdoDataType_Byte
+/// \param DataType_Byte
/// Represents unsigned 8-bit integers with values between 0 and 255
-/// \param FdoDataType_DateTime
+/// \param DataType_DateTime
/// Represents a date and time value
-/// \param FdoDataType_Decimal
+/// \param DataType_Decimal
/// Represents values ranging from 1.0 x 10^-28 to approximately 7.9 x 10^28,
/// with 28-29 significant digits
-/// \param FdoDataType_Double
+/// \param DataType_Double
/// Represents a floating point value ranging from approximately 5.0
/// x 10^-324 to 1.7 x 10^308 with a precision of 15-16 digits
-/// \param FdoDataType_Int16
+/// \param DataType_Int16
/// Represents signed 16-bit integers with values between -32768 and 32767
-/// \param FdoDataType_Int32
+/// \param DataType_Int32
/// Represents signed 32-bit integers with values between -2147483648 and 2147483647
-/// \param FdoDataType_Int64
+/// \param DataType_Int64
/// Represents signed 64-bit integers with values between -9223372036854775808 and 9223372036854775807
-/// \param FdoDataType_Single
+/// \param DataType_Single
/// Represents floating point values ranging from approximately 1.5 x 10^-45
/// to 3.4 x 10^38, with a precision of 7 digits
-/// \param FdoDataType_String
+/// \param DataType_String
/// Represents a Unicode character string
-/// \param FdoDataType_BLOB
+/// \param DataType_BLOB
/// Represents a binary large object stored as a collection of bytes
-/// \param FdoDataType_CLOB
+/// \param DataType_CLOB
/// Represents a character large object stored as a collection of
/// characters
public __value enum DataType
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDeleteRule.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDeleteRule.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDeleteRule.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -21,16 +21,16 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// The FdoDeleteRule enumeration specifies the action to take when a delete
+/// The DeleteRule enumeration specifies the action to take when a delete
/// operation is executed on the class instance at the other end of the
/// relation.
-/// <param name="FdoDeleteRule_Cascade">
+/// <param name="DeleteRule_Cascade">
/// Cascade the delete operation to class instances at this end of the relation
/// </param>
-/// <param name="FdoDeleteRule_Prevent">
+/// <param name="DeleteRule_Prevent">
/// Prevent the delete operation if there are class instances at this end of the relation
/// </param>
-/// <param name="FdoDeleteRule_Break">
+/// <param name="DeleteRule_Break">
/// Break the relationship by setting the identifying properties at this end to null values
/// </param>
public __value enum DeleteRule
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureClass.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureClass.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureClass.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -27,8 +27,8 @@
public __gc class GeometricPropertyDefinition;
/// \brief
-/// The FdoFeatureClass class can be used to represent spatial or non-spatial features.
-/// Spatial features must have at lease one geometric property. The FdoFeatureClass
+/// The FeatureClass class can be used to represent spatial or non-spatial features.
+/// Spatial features must have at lease one geometric property. FeatureClass
/// type has one pre-defined base property "Bounds". The "Bounds" read-only
/// property can be used to get the geometric boundary of the spatial feature.
/// The value of this property will be null if the feature is not a spatial
@@ -37,12 +37,12 @@
{
public:
/// \brief
- /// Constructs a default instance of an FdoFeatureClass.
+ /// Constructs a default instance of an FeatureClass.
///
FeatureClass();
/// \brief
- /// Constructs an instance of an FdoFeatureClass using the specified arguments.
+ /// Constructs an instance of an FeatureClass using the specified arguments.
///
/// \param name
/// Input name
@@ -70,8 +70,8 @@
/// \brief
/// Sets the geometric property that defines the geometry for this spatial
- /// feature class. The specified FdoGeometricPropertyDefinition must be a member
- /// of either the FdoClassDefinition.GetBaseProperties or FdoClassDefinition.GetProperties
+ /// feature class. The specified GeometricPropertyDefinition must be a member
+ /// of either ClassDefinition.GetBaseProperties or ClassDefinition.GetProperties
/// collection.
///
/// \param value
@@ -82,6 +82,16 @@
///
__property System::Void set_GeometryProperty(NAMESPACE_OSGEO_FDO_SCHEMA::GeometricPropertyDefinition* value);
+ /// \brief
+ /// Constructs a FeatureClass 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.
+ ///
FeatureClass(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureClassCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureClassCollection.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureClassCollection.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -25,13 +25,32 @@
public __gc class SchemaElement;
/// \brief
-/// The FdoFeatureClassCollection class represents a collection of FdoFeatureClasse objects.
+/// The FeatureClassCollection class represents a collection of FeatureClasse objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class FeatureClassCollection : 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
{
@@ -40,15 +59,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(FeatureClassCollection* 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();
};
@@ -56,55 +107,72 @@
inline FdoFeatureClassCollection* 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 FeatureClassCollection object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the parent schema object of the collection
+ ///
FeatureClassCollection(NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement* parent);
+ /// \brief
+ /// Constructs a FeatureClassCollection 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.
+ ///
FeatureClassCollection(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
{
}
/// \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 FeatureClass from this collection.
+ /// Removes the index-th FeatureClass from this collection.
///
/// \param index
/// Input index of the element to remove.
@@ -112,36 +180,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 FeatureClass object into the collection.
+ /// Adds a FeatureClass object into the collection.
///
/// \param value
/// Input the FeatureClass 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(FeatureClass* value);
/// \brief
- /// Determines the index of a specific FeatureClass object.
+ /// Determines the index of a specific FeatureClass object.
///
/// \param value
/// Input the FeatureClass 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(FeatureClass* value);
System::Int32 IndexOf(String* name);
/// \brief
- /// Inserts a FeatureClass object into the collection at the specified position.
+ /// Inserts a FeatureClass object into the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
@@ -151,7 +219,7 @@
System::Void Insert(System::Int32 index, FeatureClass* value);
/// \brief
- /// Removes the first occurrence of a specific FeatureClass object.
+ /// Removes the first occurrence of a specific FeatureClass object.
///
/// \param value
/// Input the FeatureClass object to remove from the collection.
@@ -159,20 +227,29 @@
System::Void Remove(FeatureClass* value);
/// \brief
- /// Determines whether the collection contains a specific FeatureClass object.
+ /// Determines whether the collection contains a specific FeatureClass object.
///
/// \param value
/// Input The FeatureClass 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(FeatureClass* value);
+ /// \brief
+ /// Determines whether the collection contains a specific FeatureClass object.
+ ///
+ /// \param value
+ /// Input The name of the FeatureClass object to search in the collection.
+ ///
+ /// \return
+ /// Returns true if the value is found in the collection; otherwise, false.
+ ///
System::Boolean Contains(String* name);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// 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.
@@ -181,19 +258,49 @@
///
System::Void CopyTo(FeatureClass* array[],System::Int32 size);
-
/// \brief
- /// Gets or sets a FeatureClass in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the FeatureClass 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 FeatureClass* 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, FeatureClass* 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 FeatureClass* 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, FeatureClass* value);
};
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureSchema.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureSchema.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureSchema.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -31,11 +31,11 @@
public __gc class ClassCollection;
/// \brief
-/// The FdoFeatureSchema class derives from FdoSchemaElement.
+/// The FeatureSchema class derives from SchemaElement.
/// A feature schema contains all of the classes and relationships
-/// that make up a particular data model. The FdoFeatureSchema class can be used to
+/// that make up a particular data model. The FeatureSchema class can be used to
/// either create a new schema or to browse the schema end of a
-/// connection. In the later case, the FdoFeatureSchema instance is created by the
+/// connection. In the later case, the FeatureSchema instance is created by the
/// DescribeSchema command. In this case the schema objects have additional properties,
/// such as coordinate system definitions that can be useful to the
/// application when placed in context with the schema objects.
@@ -43,15 +43,15 @@
{
public:
/// \brief
- /// Constructs a default empty instance of an FdoFeatureSchema.
+ /// Constructs a default empty instance of an FeatureSchema.
///
/// \return
- /// Returns FdoFeatureSchema
+ /// Returns FeatureSchema
///
FeatureSchema();
/// \brief
- /// Constructs an instance of an FdoFeatureSchema using the specified arguments.
+ /// Constructs an instance of a FeatureSchema using the specified arguments.
///
/// \param name
/// Input name
@@ -59,36 +59,25 @@
/// Input description
///
/// \return
- /// Returns FdoFeatureSchema
+ /// Returns FeatureSchema
///
FeatureSchema(System::String* name, System::String* description);
/// \brief
- /// Returns an FdoClassCollection that contains all of the classes defined in
+ /// Returns an ClassCollection that contains all of the classes defined in
/// the feature schema.
///
/// \return
- /// Returns an FdoClassCollection
+ /// Returns an ClassCollection
///
__property NAMESPACE_OSGEO_FDO_SCHEMA::ClassCollection* get_Classes();
/// \brief
- /// Returns an FdoRelationCollection that contains all of the relations defined
- /// in the feature schema.
- ///
- /// \return
- /// Returns nothing
- ///
- // TODO: I can't find the delcaration and definition files of class FdoRelationCollection in
- // in unmanaged FDO API.
- // FDO_API FdoRelationCollection* GetRelations();
-
- /// \brief
/// Accepts all of the changes that have been made to the feature schema.
/// All child elements with a schema element state set to
- /// FdoSchemaElementState_Deleted are physically removed from the schema. All
+ /// SchemaElementState_Deleted are physically removed from the schema. All
/// other child elements have their schema element state values set to
- /// FdoSchemaElementState_Unchanged.
+ /// SchemaElementState_Unchanged.
/// This method would usually be only called from an FDO Provider (IApplySchema
/// implementation). It would not normally called by an FDO Client.
///
@@ -100,7 +89,7 @@
/// \brief
/// Rejects all of the changes that have been made to the feature schema.
/// All child elements with a schema element state set to
- /// FdoSchemaElementState_Added are physically removed from the schema. All other
+ /// SchemaElementState_Added are physically removed from the schema. All other
/// child elements are restored to their original states and have their schema
/// element state values set to FdoSchemaElementState_Unchanged.
///
@@ -109,6 +98,16 @@
///
System::Void RejectChanges();
+ /// \brief
+ /// Constructs a FeatureSchema 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.
+ ///
FeatureSchema(System::IntPtr unmanaged, System::Boolean autoDelete) :NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureSchemaCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureSchemaCollection.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureSchemaCollection.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -44,9 +44,28 @@
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class FeatureSchemaCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList, public NAMESPACE_OSGEO_FDO_XML::IXmlDeserializable, public NAMESPACE_OSGEO_FDO_XML::IXmlSerializable
{
+/// \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
{
@@ -55,15 +74,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(FeatureSchemaCollection* 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();
};
@@ -71,55 +122,72 @@
inline FdoFeatureSchemaCollection* 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 FeatureSchemaCollection object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the parent schema object of the collection
+ ///
FeatureSchemaCollection(NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement* parent);
+ /// \brief
+ /// Constructs a FeatureSchemaCollection 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.
+ ///
FeatureSchemaCollection(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
{
}
/// \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 FeatureSchema from this collection.
+ /// Removes the index-th FeatureSchema from this collection.
///
/// \param index
/// Input index of the element to remove.
@@ -127,36 +195,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 FeatureSchema object into the collection.
+ /// Adds a FeatureSchema object into the collection.
///
/// \param value
/// Input the FeatureSchema 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(FeatureSchema* value);
/// \brief
- /// Determines the index of a specific FeatureSchema object.
+ /// Determines the index of a specific FeatureSchema object.
///
/// \param value
/// Input the FeatureSchema 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(FeatureSchema* value);
System::Int32 IndexOf(String* name);
/// \brief
- /// Inserts a FeatureSchema object into the collection at the specified position.
+ /// Inserts a FeatureSchema object into the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
@@ -166,7 +234,7 @@
System::Void Insert(System::Int32 index, FeatureSchema* value);
/// \brief
- /// Removes the first occurrence of a specific FeatureSchema object.
+ /// Removes the first occurrence of a specific FeatureSchema object.
///
/// \param value
/// Input the FeatureSchema object to remove from the collection.
@@ -174,20 +242,29 @@
System::Void Remove(FeatureSchema* value);
/// \brief
- /// Determines whether the collection contains a specific FeatureSchema object.
+ /// Determines whether the collection contains a specific FeatureSchema object.
///
/// \param value
/// Input The FeatureSchema 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(FeatureSchema* value);
+ /// \brief
+ /// Determines whether the collection contains a specific FeatureSchema object.
+ ///
+ /// \param value
+ /// Input The name of the FeatureSchema object to search in the collection.
+ ///
+ /// \return
+ /// Returns true if the value is found in the collection; otherwise, false.
+ ///
System::Boolean Contains(String* name);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// 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.
@@ -197,19 +274,59 @@
System::Void CopyTo(FeatureSchema* array[],System::Int32 size);
/// \brief
- /// Gets or sets a FeatureSchema in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the FeatureSchema 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 FeatureSchema* 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 FeatureSchema* 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, FeatureSchema* 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 FeatureSchema* 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, FeatureSchema* value);
/*
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgGeometricPropertyDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgGeometricPropertyDefinition.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgGeometricPropertyDefinition.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -26,12 +26,12 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// FdoGeometricPropertyDefinition derives from FdoPropertyDefinition and represents a
+/// GeometricPropertyDefinition derives from PropertyDefinition and represents a
/// geometric value. Geometric properties can take on any of the geometric types
-/// listed in the FdoGeometricType enumeration.
+/// listed in the GeometricType enumeration.
/// Note: Geometric properties do
/// not actually store the coordinate system or measure units, this is to enable
-/// the use of the same schema in different geometric locals. FdoGeometricType
+/// the use of the same schema in different geometric locals. GeometricType
/// informs the client application what types of geometric primitives it can
/// expect when reading a particular geometric property (and what types they can
/// store in the property on insert/update). The client application can
@@ -41,12 +41,12 @@
{
public:
/// \brief
- /// Constructs a default instance of an FdoGeometricPropertyDefinition.
+ /// Constructs a default instance of an GeometricPropertyDefinition.
///
GeometricPropertyDefinition();
/// \brief
- /// Constructs an instance of an FdoGeometricPropertyDefinition using the
+ /// Constructs an instance of an GeometricPropertyDefinition using the
/// specified arguments.
///
/// \param name
@@ -70,22 +70,22 @@
__property NAMESPACE_OSGEO_FDO_SCHEMA::PropertyType get_PropertyType();
/// \brief
- /// Gets the FdoGeometricTypes that can be stored in this geometric property.
+ /// Gets the GeometricTypes that can be stored in this geometric property.
/// The returned value may be any combination of the values from the
- /// FdoGeometricType enumeration combined via a bit-wise or operation.
+ /// GeometricType enumeration combined via a bit-wise or operation.
///
/// \return
- /// Returns the FdoGeometricTypes that can be stored in this geometric property
+ /// Returns the GeometricTypes that can be stored in this geometric property
///
__property System::Int32 get_GeometryTypes();
/// \brief
- /// Sets the FdoGeometricTypes that can be stored in this geometric property.
- /// The value may be any combination of the values from the FdoGeometricType
+ /// Sets the GeometricTypes that can be stored in this geometric property.
+ /// The value may be any combination of the values from GeometricType
/// enumeration combined via a bit-wise or operation.
///
/// \param value
- /// Input the FdoGeometricTypes that can be stored in this geometric property
+ /// Input the GeometricTypes that can be stored in this geometric property
///
/// \return
/// Returns nothing
@@ -216,6 +216,16 @@
///
__property System::String * get_SpatialContextAssociation();
+ /// \brief
+ /// Constructs a GeometricPropertyDefinition 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.
+ ///
GeometricPropertyDefinition(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_SCHEMA::PropertyDefinition(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkClass.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkClass.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkClass.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -27,25 +27,25 @@
public __gc class NetworkLayerClass;
/// \brief
-/// FdoNetworkClass derives from FdoClassDefinition and can be used to represent a
-/// linear network. The FdoNetworkClass type has 2 pre-defined base properties. The first is a FdoBoolean
-/// type called "Directed". And the second is a FdoObjectPropertyDefinition of an ordered collection called "Layers".
+/// The NetworkClass derives from ClassDefinition and can be used to represent a
+/// linear network. The NetworkClass has 2 pre-defined base properties. The first is a Boolean
+/// type called "Directed". And the second is a ObjectPropertyDefinition of an ordered collection called "Layers".
/// The "Directed" property is used to indicate if the network is directed or undirected.
/// The network is directed if the Directed property is set to true. Otherwise, it is undirected. The Layers property
-/// is used to contain the ordered list of layers. The class of the layers object property must be of type FdoNetworkLayer.
+/// is used to contain the ordered list of layers. The class of the layers object property must be of type NetworkLayer.
/// <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 class NetworkClass : public NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition
{
public:
/// \brief
- /// Constructs a default instance of an FdoNetworkClass.
+ /// Constructs a default instance of an NetworkClass.
///
NetworkClass();
/// \brief
- /// Constructs an instance of an FdoNetworkClass using the specified arguments.
+ /// Constructs an instance of an NetworkClass using the specified arguments.
///
/// \param name
/// Input name
@@ -82,6 +82,16 @@
///
__property System::Void set_LayerClass(NAMESPACE_OSGEO_FDO_SCHEMA::NetworkLayerClass* value);
+ /// \brief
+ /// Constructs a NetworkClass 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.
+ ///
NetworkClass(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkFeatureClass.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkFeatureClass.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkFeatureClass.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -27,8 +27,8 @@
public __gc class AssociationPropertyDefinition;
/// \brief
-/// FdoNetworkFeature is an abstract class that derives from FdoFeatureClass and is a base
-/// for the FdoNetworkNodeFeature and FdoNetworkLinkFeature.
+/// NetworkFeature is an abstract class that derives from FeatureClass and is a base
+/// for NetworkNodeFeature and NetworkLinkFeature.
/// <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
/// the software related to the content herein.</span>
@@ -111,6 +111,16 @@
///
__property System::Void set_ParentNetworkFeatureProperty(NAMESPACE_OSGEO_FDO_SCHEMA::AssociationPropertyDefinition* value);
+ /// \brief
+ /// Constructs a NetworkFeatureClass 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.
+ ///
NetworkFeatureClass(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_SCHEMA::FeatureClass(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkLayerClass.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkLayerClass.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkLayerClass.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -26,21 +26,20 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// FdoNetworkLayerClass derives from FdoClassDefinition and can be used to represent a
-/// network layer.
+/// NetworkLayerClass derives from ClassDefinition and can be used to represent a network layer.
/// <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 class NetworkLayerClass : public NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition
{
public:
/// \brief
- /// Constructs a default instance of an FdoNetworkLayerClass.
+ /// Constructs a default instance of an NetworkLayerClass.
///
NetworkLayerClass();
/// \brief
- /// Constructs an instance of an FdoNetworkLayerClass using the specified arguments.
+ /// Constructs an instance of an NetworkLayerClass using the specified arguments.
///
/// \param name
/// Input name
@@ -57,6 +56,16 @@
///
__property NAMESPACE_OSGEO_FDO_SCHEMA::ClassType get_ClassType();
+ /// \brief
+ /// Constructs a NetworkLayerClass 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.
+ ///
NetworkLayerClass(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkLinkFeatureClass.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkLinkFeatureClass.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkLinkFeatureClass.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -27,21 +27,21 @@
public __gc class AssociationPropertyDefinition;
/// \brief
-/// FdoNetworkLinkFeature derives from FdoNetworkFeature
+/// NetworkLinkFeature derives NetworkFeature
/// and can be used to represent a logical link feature.
/// <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 class NetworkLinkFeatureClass : public NAMESPACE_OSGEO_FDO_SCHEMA::NetworkFeatureClass
{
public:
/// \brief
- /// Constructs a default instance of an FdoNetworkLinkFeatureClass.
+ /// Constructs a default instance of an NetworkLinkFeatureClass.
///
NetworkLinkFeatureClass();
/// \brief
- /// Constructs an instance of an FdoNetworkLinkFeatureClass using the specified arguments.
+ /// Constructs an instance of an NetworkLinkFeatureClass using the specified arguments.
///
/// \param name
/// Input name
@@ -96,6 +96,16 @@
///
__property System::Void set_EndNodeProperty(NAMESPACE_OSGEO_FDO_SCHEMA::AssociationPropertyDefinition* value);
+ /// \brief
+ /// Constructs a NetworkLinkFeatureClass 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.
+ ///
NetworkLinkFeatureClass(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_SCHEMA::NetworkFeatureClass(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkNodeFeatureClass.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkNodeFeatureClass.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgNetworkNodeFeatureClass.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -27,21 +27,21 @@
public __gc class AssociationPropertyDefinition;
/// \brief
-/// FdoNetworkNodeFeature derives from FdoNetworkFeature and can be used to represent a
+/// NetworkNodeFeature derives from NetworkFeature and can be used to represent a
/// logical node feature.
/// <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 class NetworkNodeFeatureClass : public NAMESPACE_OSGEO_FDO_SCHEMA::NetworkFeatureClass
{
public:
/// \brief
- /// Constructs a default instance of an FdoNetworkNodeFeatureClass.
+ /// Constructs a default instance of an NetworkNodeFeatureClass.
///
NetworkNodeFeatureClass();
/// \brief
- /// Constructs an instance of an FdoNetworkNodeFeatureClass using the specified arguments.
+ /// Constructs an instance of an NetworkNodeFeatureClass using the specified arguments.
///
/// \param name
/// Input name
@@ -68,7 +68,7 @@
/// \brief
/// Sets a reference to the layer property. The associated class of the layer
- /// association property must be an FdoNetworkLayer.
+ /// association property must be an NetworkLayer.
///
/// \param value
/// Input an association property definition
@@ -78,6 +78,16 @@
///
__property System::Void set_LayerProperty(NAMESPACE_OSGEO_FDO_SCHEMA::AssociationPropertyDefinition* value);
+ /// \brief
+ /// Constructs a NetworkNodeFeatureClass 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.
+ ///
NetworkNodeFeatureClass(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_SCHEMA::NetworkFeatureClass(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgObjectPropertyDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgObjectPropertyDefinition.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgObjectPropertyDefinition.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -29,7 +29,7 @@
public __gc class DataPropertyDefinition;
/// \brief
-/// The FdoObjectPropertyDefinition class derives from FdoPropertyDefinition and represents
+/// ObjectPropertyDefinition class derives PropertyDefinition and represents
/// containment of an object or a collection of objects within another class.
/// The class of the contained object must already be defined in the feature
/// schema and cannot be abstract.
@@ -37,12 +37,12 @@
{
public:
/// \brief
- /// Constructs a default instance of an FdoObjectPropertyDefinition.
+ /// Constructs a default instance of an ObjectPropertyDefinition.
///
ObjectPropertyDefinition();
/// \brief
- /// Constructs an instance of an FdoObjectPropertyDefinition using the specified
+ /// Constructs an instance of an ObjectPropertyDefinition using the specified
/// arguments.
///
/// \param name
@@ -58,7 +58,7 @@
ObjectPropertyDefinition(System::String* name, System::String* description, System::Boolean system);
/// \brief
- /// Gets a reference to the FdoClassDefinition that defines the type of this
+ /// Gets a reference to the ClassDefinition that defines the type of this
/// property.
///
/// \return
@@ -67,7 +67,7 @@
__property NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition* get_Class();
/// \brief
- /// Sets a reference to the FdoClassDefinition that defines the type of this
+ /// Sets a reference to the ClassDefinition that defines the type of this
/// property.
///
/// \param value
@@ -79,10 +79,10 @@
__property System::Void set_Class(NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition* value);
/// \brief
- /// Gets a reference to an FdoDataPropertyDefinition to use for uniquely identifying
+ /// Gets a reference to an DataPropertyDefinition to use for uniquely identifying
/// instances of the contained class within a single parent object instance.
- /// This value is only used for the FdoObjectType_Collection and FdoObjectType_OrderedCollection object
- /// property types. The FdoDataPropertyDefinition must belong to the FdoClassDefinition that
+ /// This value is only used for ObjectType_Collection and ObjectType_OrderedCollection object
+ /// property types. The DataPropertyDefinition must belong to the ClassDefinition that
/// defines the type of this property.
///
/// \return
@@ -91,10 +91,10 @@
__property NAMESPACE_OSGEO_FDO_SCHEMA::DataPropertyDefinition* get_IdentityProperty();
/// \brief
- /// Sets a reference to an FdoDataPropertyDefinition to use for uniquely identifying
+ /// Sets a reference to an DataPropertyDefinition to use for uniquely identifying
/// instances of the contained class within a single parent object instance.
- /// This value is only used for the FdoObjectType_Collection and FdoObjectType_OrderedCollection object
- /// property types. The FdoDataPropertyDefinition must belong to the FdoClassDefinition that
+ /// This value is only used for ObjectType_Collection and ObjectType_OrderedCollection object
+ /// property types. The DataPropertyDefinition must belong to the ClassDefinition that
/// defines the type of this property.
///
/// \param value
@@ -129,7 +129,7 @@
/// \brief
/// Gets the order type of this object property (ascending or descending).
/// This property is only applicable if the property type is set to
- /// FdoObjectType_OrderedCollection.
+ /// ObjectType_OrderedCollection.
///
/// \return
/// Returns the order type
@@ -139,7 +139,7 @@
/// \brief
/// Sets the order type of this object property (ascending or descending).
/// This property is only applicable if the property type is set to
- /// FdoObjectType_OrderedCollection.
+ /// ObjectType_OrderedCollection.
///
/// \param value
/// Input the order type
@@ -149,6 +149,16 @@
///
__property System::Void set_OrderType(NAMESPACE_OSGEO_FDO_SCHEMA::OrderType value);
+ /// \brief
+ /// Constructs a ObjectPropertyDefinition 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.
+ ///
ObjectPropertyDefinition(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_SCHEMA::PropertyDefinition(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgObjectType.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgObjectType.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgObjectType.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -21,15 +21,15 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// The FdoObjectType enumeration defines whether an object property is a single
+/// The ObjectType enumeration defines whether an object property is a single
/// value, a collection, or an ordered collection.
-/// <param name="FdoObjectType_Value">
+/// <param name="ObjectType_Value">
/// Represents a simple value property
/// </param>
-/// <param name="FdoObjectType_Collection">
+/// <param name="ObjectType_Collection">
/// Represents a property that is a collection of values
/// </param>
-/// <param name="FdoObjectType_OrderedCollection">
+/// <param name="ObjectType_OrderedCollection">
/// Represents a property that is an ordered collection of values
/// </param>
public __value enum ObjectType
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgOrderType.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgOrderType.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgOrderType.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -21,12 +21,12 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// The FdoOrderType enumeration list contains two values to indicate if the
+/// The OrderType enumeration list contains two values to indicate if the
/// object collection is to be ordered in ascending or descending fashion.
-/// <param name="FdoOrderType_Ascending">
+/// <param name="OrderType_Ascending">
/// Specifies the collection is to be ordered from the smallest value to the largest value
/// </param>
-/// <param name="FdoOrderType_Descending">
+/// <param name="OrderType_Descending">
/// Specifies the collection is to be ordered from the largest value to the smallest value
/// </param>
public __value enum OrderType
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyDefinition.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyDefinition.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -26,9 +26,9 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// FdoPropertyDefinition is an abstract class that derives from FdoSchemaElement.
-/// FdoPropertyDefinition is the base class of FdoDataPropertyDefinition,
-/// FdoGeometricPropertyDefinition, and FdoObjectPropertyDefinition.
+/// PropertyDefinition is an abstract class that derives from SchemaElement.
+/// PropertyDefinition is the base class of DataPropertyDefinition,
+/// GeometricPropertyDefinition, and ObjectPropertyDefinition.
public __gc class PropertyDefinition : public NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement
{
public:
@@ -67,6 +67,16 @@
///
__property System::Void set_IsSystem(System::Boolean value);
+ /// \brief
+ /// Constructs a PropertyDefinition 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.
+ ///
PropertyDefinition(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyDefinitionCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyDefinitionCollection.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyDefinitionCollection.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -25,13 +25,32 @@
public __gc class SchemaElement;
/// \brief
-/// The FdoPropertyDefinitionCollection class represents a collection of FdoPropertyDefinition objects.
+/// The PropertyDefinitionCollection class represents a collection of PropertyDefinition objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class PropertyDefinitionCollection : 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
{
@@ -40,15 +59,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(PropertyDefinitionCollection* 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();
};
@@ -56,55 +107,72 @@
inline FdoPropertyDefinitionCollection* 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 PropertyDefinitionCollection object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the parent schema object of the collection
+ ///
PropertyDefinitionCollection(NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement* parent);
+ /// \brief
+ /// Constructs a PropertyDefinitionCollection 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.
+ ///
PropertyDefinitionCollection(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
{
}
/// \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 PropertyDefinition from this collection.
+ /// Removes the index-th PropertyDefinition from this collection.
///
/// \param index
/// Input index of the element to remove.
@@ -112,36 +180,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 PropertyDefinition object into the collection.
+ /// Adds a PropertyDefinition object into the collection.
///
/// \param value
/// Input the PropertyDefinition 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(PropertyDefinition* value);
/// \brief
- /// Determines the index of a specific PropertyDefinition object.
+ /// Determines the index of a specific PropertyDefinition object.
///
/// \param value
/// Input the PropertyDefinition 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(PropertyDefinition* value);
System::Int32 IndexOf(String* name);
/// \brief
- /// Inserts a PropertyDefinition object into the collection at the specified position.
+ /// Inserts a PropertyDefinition object into the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
@@ -151,7 +219,7 @@
System::Void Insert(System::Int32 index, PropertyDefinition* value);
/// \brief
- /// Removes the first occurrence of a specific PropertyDefinition object.
+ /// Removes the first occurrence of a specific PropertyDefinition object.
///
/// \param value
/// Input the PropertyDefinition object to remove from the collection.
@@ -159,20 +227,29 @@
System::Void Remove(PropertyDefinition* value);
/// \brief
- /// Determines whether the collection contains a specific PropertyDefinition object.
+ /// Determines whether the collection contains a specific PropertyDefinition object.
///
/// \param value
/// Input The PropertyDefinition 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(PropertyDefinition* value);
+ /// \brief
+ /// Determines whether the collection contains a specific PropertyDefinition object.
+ ///
+ /// \param value
+ /// Input The name of the PropertyDefinition object to search in the collection.
+ ///
+ /// \return
+ /// Returns true if the value is found in the collection; otherwise, false.
+ ///
System::Boolean Contains(String* name);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// 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.
@@ -181,21 +258,60 @@
///
System::Void CopyTo(PropertyDefinition* array[],System::Int32 size);
-
/// \brief
- /// Gets or sets a PropertyDefinition in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the PropertyDefinition 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 PropertyDefinition* 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 PropertyDefinition* 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, PropertyDefinition* 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 PropertyDefinition* 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, PropertyDefinition* value);
};
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyType.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyType.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyType.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -21,20 +21,20 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// The FdoPropertyType enumeration lists the possible types that a Property can be.
-/// <param name="FdoPropertyType_DataProperty">
+/// The PropertyType enumeration lists the possible types that a Property can be.
+/// <param name="PropertyType_DataProperty">
/// Represents a Data Property type
/// </param>
-/// <param name="FdoPropertyType_ObjectProperty">
+/// <param name="PropertyType_ObjectProperty">
/// Represents an Object Property type
/// </param>
-/// <param name="FdoPropertyType_GeometricProperty">
+/// <param name="PropertyType_GeometricProperty">
/// Represents a Geometric Property type
/// </param>
-/// <param name="FdoPropertyType_AssociationProperty">
+/// <param name="PropertyType_AssociationProperty">
/// Represents an Association Property type
/// </param>
-/// <param name="FdoPropertyType_RasterProperty">
+/// <param name="PropertyType_RasterProperty">
/// Represents a Raster (image) Property type
/// </param>
public __value enum PropertyType
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyValueConstraint.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyValueConstraint.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyValueConstraint.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -25,9 +25,9 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// FdoPropertyValueConstraint is an abstract class that derives from FdoIDisposable.
-/// FdoPropertyValueConstraint is the base class of FdoPropertyValueConstraintRange
-/// and FdoPropertyValueConstraintList.
+/// PropertyValueConstraint is an abstract class that derives from IDisposable.
+/// PropertyValueConstraint is the base class of PropertyValueConstraintRange
+/// and PropertyValueConstraintList.
public __gc class PropertyValueConstraint : public NAMESPACE_OSGEO_RUNTIME::Disposable
{
public private:
@@ -35,8 +35,10 @@
inline FdoPropertyValueConstraint* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyValueConstraintList.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyValueConstraintList.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyValueConstraintList.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -29,7 +29,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// FdoPropertyValueConstraintList is used to specify a list of allowed values for a particular property.
+/// PropertyValueConstraintList is used to specify a list of allowed values for a particular property.
/// It can be used for all data property types except for Boolean, BLOB, or CLOB.
/// This constraint is represented by a list of values of the same type as the corresponding data property.
/// The list cannot be empty. The list could be a single value. While that may not seem very useful it could serve as a
@@ -54,10 +54,10 @@
public:
/// \brief
- /// Constructs an empty instance of an FdoPropertyValueConstraintList.
+ /// Constructs an empty instance of an PropertyValueConstraintList.
///
/// \return
- /// Returns an FdoPropertyValueConstraintList
+ /// Returns an PropertyValueConstraintList
///
PropertyValueConstraintList();
@@ -65,7 +65,7 @@
/// Returns the list of allowed values for a particular property.
///
/// \return
- /// Returns na instance of FdoDataValueCollection.
+ /// Returns an instance of DataValueCollection.
///
__property NAMESPACE_OSGEO_FDO_EXPRESSION::DataValueCollection* get_ConstraintList();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyValueConstraintRange.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyValueConstraintRange.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyValueConstraintRange.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -29,7 +29,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// FdoPropertyValueConstraintRange is used to specify minimum and / or maximum allowed values for a particular property.
+/// PropertyValueConstraintRange is used to specify minimum and / or maximum allowed values for a particular property.
/// It can be used for all data property types except for Boolean, BLOB, or CLOB.
/// One or the other or both of MinValue and MaxValue must be specified. If both are specified, then MaxValue must be greater
/// than or equal to MinValue and if either MinInclusive or MaxInclusive are false, then MaxValue must be greater than MinValue.
@@ -46,15 +46,15 @@
public:
/// \brief
- /// Constructs an empty instance of an FdoPropertyValueConstraintRange.
+ /// Constructs an empty instance of an PropertyValueConstraintRange.
///
/// \return
- /// Returns an FdoPropertyValueConstraintRange
+ /// Returns an PropertyValueConstraintRange
///
PropertyValueConstraintRange();
/// \brief
- /// Constructs and populates an instance of an FdoPropertyValueConstraintRange.
+ /// Constructs and populates an instance of an PropertyValueConstraintRange.
///
/// \param minValue
/// Minimum allowed value
@@ -62,7 +62,7 @@
/// Maximum allowed value
///
/// \return
- /// Returns an FdoPropertyValueConstraintRange
+ /// Returns an PropertyValueConstraintRange
///
PropertyValueConstraintRange(NAMESPACE_OSGEO_FDO_EXPRESSION::DataValue* minValue, NAMESPACE_OSGEO_FDO_EXPRESSION::DataValue* maxValue );
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgRasterPropertyDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgRasterPropertyDefinition.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgRasterPropertyDefinition.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -29,7 +29,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// The FdoRasterPropertyDefinition has the information needed to
+/// RasterPropertyDefinition has the information needed to
/// create or completely describe a raster property. This class encapsulates
/// the information necessary to insert a 'new' raster, in the absence of
/// any other information, for the properties defined using this schema
@@ -38,12 +38,12 @@
{
public:
/// \brief
- /// Constructs a default instance of an FdoRasterPropertyDefinition.
+ /// Constructs a default instance of an RasterPropertyDefinition.
///
RasterPropertyDefinition();
/// \brief
- /// Constructs an instance of an FdoRasterPropertyDefinition using the
+ /// Constructs an instance of an RasterPropertyDefinition using the
/// specified arguments.
///
/// \param name
@@ -59,7 +59,7 @@
RasterPropertyDefinition(System::String* name, System::String* description, System::Boolean system);
//
- // FdoPropertyDefinition interface
+ // PropertyDefinition interface
//
/// \brief
@@ -186,6 +186,16 @@
///
__property System::String* get_SpatialContextAssociation();
+ /// \brief
+ /// Constructs a RasterPropertyDefinition 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.
+ ///
RasterPropertyDefinition(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_SCHEMA::PropertyDefinition(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgReadOnlyDataPropertyDefinitionCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgReadOnlyDataPropertyDefinitionCollection.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgReadOnlyDataPropertyDefinitionCollection.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -25,13 +25,32 @@
public __gc class DataPropertyDefinitionCollection;
/// \brief
-/// The FdoReadOnlyDataPropertyDefinitionCollection class represents a collection of FdoDataPropertyDefinition objects.
+/// The ReadOnlyDataPropertyDefinitionCollection class represents a collection of DataPropertyDefinition objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class ReadOnlyDataPropertyDefinitionCollection : 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
{
@@ -40,15 +59,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(ReadOnlyDataPropertyDefinitionCollection* 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();
};
@@ -65,49 +116,72 @@
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public:
+ /// \brief
+ /// Constructs a ReadOnlyDataPropertyDefinitionCollection object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the parent schema object of the collection
+ ///
ReadOnlyDataPropertyDefinitionCollection(NAMESPACE_OSGEO_FDO_SCHEMA::DataPropertyDefinitionCollection* parent);
+ /// \brief
+ /// Constructs a ReadOnlyDataPropertyDefinitionCollection 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.
+ ///
ReadOnlyDataPropertyDefinitionCollection(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
{
}
/// \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
- /// Determines the index of a specific DataPropertyDefinition object.
+ /// Determines the index of a specific DataPropertyDefinition object.
///
/// \param value
/// Input the DataPropertyDefinition 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_SCHEMA::DataPropertyDefinition* value);
/// \brief
- /// Determines whether the collection contains a specific DataPropertyDefinition object.
+ /// Determines whether the collection contains a specific DataPropertyDefinition object.
///
/// \param value
/// Input The DataPropertyDefinition 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_SCHEMA::DataPropertyDefinition* 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.
@@ -116,13 +190,16 @@
///
System::Void CopyTo(NAMESPACE_OSGEO_FDO_SCHEMA::DataPropertyDefinition* array[],System::Int32 index);
-
/// \brief
- /// Gets or sets a DataPropertyDefinition in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the DataPropertyDefinition 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_SCHEMA::DataPropertyDefinition* get_RealTypeItem(System::Int32 index);
__property NAMESPACE_OSGEO_FDO_SCHEMA::DataPropertyDefinition* get_RealTypeItem(System::String* name);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgReadOnlyPropertyDefinitionCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgReadOnlyPropertyDefinitionCollection.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgReadOnlyPropertyDefinitionCollection.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -25,13 +25,32 @@
public __gc class PropertyDefinitionCollection;
/// \brief
-/// The FdoReadOnlyPropertyDefinitionCollection class represents a collection of FdoPropertyDefinition objects.
+/// The ReadOnlyPropertyDefinitionCollection class represents a collection of PropertyDefinition objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class ReadOnlyPropertyDefinitionCollection : 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
{
@@ -40,15 +59,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(ReadOnlyPropertyDefinitionCollection* 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();
};
@@ -65,49 +116,72 @@
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public:
+ /// \brief
+ /// Constructs a ReadOnlyPropertyDefinitionCollection object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the parent schema object of the collection
+ ///
ReadOnlyPropertyDefinitionCollection(NAMESPACE_OSGEO_FDO_SCHEMA::PropertyDefinitionCollection* parent);
+ /// \brief
+ /// Constructs a ReadOnlyPropertyDefinitionCollection 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.
+ ///
ReadOnlyPropertyDefinitionCollection(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
{
}
/// \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
- /// Determines the index of a specific PropertyDefinition object.
+ /// Determines the index of a specific PropertyDefinition object.
///
/// \param value
/// Input the PropertyDefinition 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_SCHEMA::PropertyDefinition* value);
/// \brief
- /// Determines whether the collection contains a specific PropertyDefinition object.
+ /// Determines whether the collection contains a specific PropertyDefinition object.
///
/// \param value
/// Input The PropertyDefinition 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_SCHEMA::PropertyDefinition* 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.
@@ -116,13 +190,16 @@
///
System::Void CopyTo(NAMESPACE_OSGEO_FDO_SCHEMA::PropertyDefinition* array[],System::Int32 index);
-
/// \brief
- /// Gets or sets a PropertyDefinition in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the PropertyDefinition 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_SCHEMA::PropertyDefinition* get_RealTypeItem(System::Int32 index);
__property NAMESPACE_OSGEO_FDO_SCHEMA::PropertyDefinition* get_RealTypeItem(System::String* name);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgSchemaAttributeDictionary.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgSchemaAttributeDictionary.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgSchemaAttributeDictionary.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -23,7 +23,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// The FdoSchemaAttributeDictionary class maintains a dictionary of named
+/// The SchemaAttributeDictionary class maintains a dictionary of named
/// attributes that provide a generic extensibility mechanism for objects
/// in the feature schema. This mechanism can be used to dynamically extend
/// schema elements in either an application- or provider-specific manner.
@@ -116,13 +116,25 @@
///
System::Void Clear();
+ /// \brief
+ /// Constructs a SchemaAttributeDictionary 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.
+ ///
SchemaAttributeDictionary(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_COMMON_XML::XmlSaxHandler(unmanaged, autoDelete)
{
}
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
inline FdoSchemaAttributeDictionary* GetImpObj();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgSchemaElement.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgSchemaElement.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgSchemaElement.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -27,26 +27,26 @@
public __gc class SchemaAttributeDictionary;
/// \brief
-/// FdoSchemaElement is an abstract class that acts as a base class for all classes
+/// SchemaElement is an abstract class that acts as a base class for all classes
/// in the Schema package.
public __gc class SchemaElement : public NAMESPACE_OSGEO_COMMON_XML::XmlSaxHandler
{
public:
/// \brief
- /// Gets the parent of this FdoSchemaElement or null if this object has not
+ /// Gets the parent of this SchemaElement or null if this object has not
/// been added to a parent object.
///
/// \return
- /// Returns FdoSchemaElement of parent
+ /// Returns SchemaElement of parent
///
__property NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement* get_Parent();
/// \brief
- /// Gets the FdoFeatureSchema this object is a part of. Returns null if this
+ /// Gets the FeatureSchema this object is a part of. Returns null if this
/// object has not been added to a feature schema.
///
/// \return
- /// Returns FdoFeatureSchema this object is a part of
+ /// Returns the FeatureSchema this object is a part of
///
__property NAMESPACE_OSGEO_FDO_SCHEMA::FeatureSchema* get_FeatureSchema();
@@ -59,11 +59,11 @@
__property NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElementState get_ElementState();
/// \brief
- /// Gets an FdoSchemaAttributeDictionary that contains the attributes
- /// associated with this FdoSchemaElement.
+ /// Gets an SchemaAttributeDictionary that contains the attributes
+ /// associated with this SchemaElement.
///
/// \return
- /// Returns an FdoSchemaAttributeDictionary
+ /// Returns an SchemaAttributeDictionary
///
__property NAMESPACE_OSGEO_FDO_SCHEMA::SchemaAttributeDictionary* get_Attributes();
@@ -126,9 +126,9 @@
/// \brief
/// Marks the schema element for deletion by setting the element state to
- /// FdoSchemaElementState_Deleted. If the schema elements current state is
- /// FdoSchemaElementState_Added then the element is physically removed. If
- /// the current state is FdoSchemaElementState_Detached this method does
+ /// SchemaElementState_Deleted. If the schema elements current state is
+ /// SchemaElementState_Added then the element is physically removed. If
+ /// the current state is SchemaElementState_Detached this method does
/// nothing.
///
/// \return
@@ -136,13 +136,25 @@
///
System::Void Delete();
+ /// \brief
+ /// Constructs a SchemaElement 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.
+ ///
SchemaElement(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_COMMON_XML::XmlSaxHandler(unmanaged, autoDelete)
{
}
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
inline FdoSchemaElement* GetImpObj();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgSchemaElementState.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgSchemaElementState.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgSchemaElementState.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -21,20 +21,20 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// The FdoSchemaElementState enumeration defines the current state of the schema element
-/// <param name="FdoSchemaElementState_Added">
+/// The SchemaElementState enumeration defines the current state of the schema element
+/// <param name="SchemaElementState_Added">
/// Indicates the schema element has been added
/// </param>
-/// <param name="FdoSchemaElementState_Deleted">
+/// <param name="SchemaElementState_Deleted">
/// Indicates the schema element is marked for deletion
/// </param>
-/// <param name="FdoSchemaElementState_Detached">
-/// Indicates the schema element is not associated with an FdoFeatureSchema
+/// <param name="SchemaElementState_Detached">
+/// Indicates the schema element is not associated with an FeatureSchema
/// </param>
-/// <param name="FdoSchemaElementState_Modified">
+/// <param name="SchemaElementState_Modified">
/// Indicates the schema element has been modified in some way
/// </param>
-/// <param name="FdoSchemaElementState_Unchanged">
+/// <param name="SchemaElementState_Unchanged">
/// Indicates the schema element has not been changed
/// </param>
public __value enum SchemaElementState
@@ -45,7 +45,7 @@
/// Indicates the schema element is marked for deletion.
SchemaElementState_Deleted = FdoSchemaElementState_Deleted,
- /// Indicates the schema element is not associated with an FdoFeatureSchema.
+ /// Indicates the schema element is not associated with an FeatureSchema.
SchemaElementState_Detached = FdoSchemaElementState_Detached,
/// Indicates the schema element has been modified in some way.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgTopoFeaturePropertyDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgTopoFeaturePropertyDefinition.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgTopoFeaturePropertyDefinition.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -25,17 +25,17 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// FdoTopoFeaturePropertyDefinition derives from FdoPropertyDefinition and its
+/// TopoFeaturePropertyDefinition derives PropertyDefinition and its
/// values can be used to relate topological primitives to one or more
/// application domain features. One can use the short form "TopoFeature" to
/// refer to these properties. The semantics of this property are similar to
-/// Object properties. One uses FdoIFeatureReader::GetObject() to retrieve
+/// Object properties. One uses IFeatureReader::GetObject() to retrieve
/// values.
/// <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>
/// \remarks
-/// FdoTopoFeaturePropertyDefinition and FdoTopoGeometryPropertyDefinition are
+/// TopoFeaturePropertyDefinition and TopoGeometryPropertyDefinition are
/// the matching roles of many:many relationships between topological primitives
/// and application domain features. FDO Association properties are not used for
/// these roles because topological relationships are not between fixed classes.
@@ -46,13 +46,22 @@
{
public:
/// \brief
- /// Constructs an instance of an FdoTopoFeaturePropertyDefinition using the
+ /// Constructs an instance of an TopoFeaturePropertyDefinition using the
/// specified arguments.
///
TopoFeaturePropertyDefinition(System::String* name, System::String* description);
-
TopoFeaturePropertyDefinition(System::String* name, System::String* description, System::Boolean system);
+ /// \brief
+ /// Constructs a TopoFeaturePropertyDefinition 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.
+ ///
TopoFeaturePropertyDefinition(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_SCHEMA::PropertyDefinition(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgTopoGeometryPropertyDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgTopoGeometryPropertyDefinition.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgTopoGeometryPropertyDefinition.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -24,9 +24,37 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
+/// \brief
+/// TopoGeometryPropertyDefinition derives from
+/// GeometricPropertyDefinition, but it has behavior of both geometry and
+/// fixed association. It can be used to relate an application-domain feature
+/// class (other than a topological primitive class) to a topology. One can use
+/// the short form TopoGeometry to refer to these properties. Values of this
+/// property can be used:
+/// <ul>
+/// <li> as spatial geometries; use FdoIFeatureReader::GetGeometry().
+/// <li> to gain access to relationships to underlying features, including
+/// topology primitives, similar to Association Properties; e.g. use
+/// IFeatureReader::GetObject() to retrieve, and associated feature
+/// identifiers to insert/update.
+/// </ul>
+/// \note
+/// This Help topic is provided for informational use only. There is
+/// no interface or support provided. OSGeo reserves the right to change
+/// the software related to the content herein.
public __gc class TopoGeometryPropertyDefinition : public NAMESPACE_OSGEO_FDO_SCHEMA::GeometricPropertyDefinition
{
public:
+ /// \brief
+ /// Constructs a TopoGeometryPropertyDefinition 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.
+ ///
TopoGeometryPropertyDefinition(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_SCHEMA::GeometricPropertyDefinition(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgTopology.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgTopology.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgTopology.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -24,9 +24,25 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
+/// \brief
+/// This class is used to represent a topology.
+/// \note
+/// This Help topic is provided for informational use only. There is
+/// no interface or support provided. OSGeo reserves the right to change
+/// the software related to the content herein.
public __gc class Topology : public NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition
{
public:
+ /// \brief
+ /// Constructs a Topology 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.
+ ///
Topology(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgUniqueConstraint.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgUniqueConstraint.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgUniqueConstraint.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -25,15 +25,17 @@
BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
/// \brief
-/// FdoUniqueConstraint can be used to specify that a property or list of properties taken together
+/// UniqueConstraint can be used to specify that a property or list of properties taken together
/// have unique values for all objects of that class in a datastore. A unique constraint that is based on a list
/// of two or more properties is called a composite unique constraint.
/// This constraint type applies to all data property types except for Boolean, BLOB, and CLOB. A Boolean property
/// can be included if it’s part of a composite unique constraint.
public __gc class UniqueConstraint : public NAMESPACE_OSGEO_RUNTIME::Disposable
{
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
UniqueConstraint(System::IntPtr unmanaged, System::Boolean autoDelete);
@@ -42,10 +44,10 @@
public:
/// \brief
- /// Constructs an empty instance of an FdoUniqueConstraint.
+ /// Constructs an empty instance of an UniqueConstraint.
///
/// \return
- /// Returns an FdoUniqueConstraint.
+ /// Returns an UniqueConstraint.
///
UniqueConstraint( );
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgUniqueConstraintCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgUniqueConstraintCollection.h 2007-02-02 00:18:51 UTC (rev 704)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgUniqueConstraintCollection.h 2007-02-02 00:39:40 UTC (rev 705)
@@ -25,13 +25,32 @@
public __gc class UniqueConstraint;
/// \brief
-/// The FdoUniqueConstraintCollection class represents a collection of FdoUniqueConstraint objects.
+/// The UniqueConstraintCollection class represents a collection of UniqueConstraint objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class UniqueConstraintCollection : 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
{
@@ -40,15 +59,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(UniqueConstraintCollection* 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();
};
@@ -56,53 +107,64 @@
inline FdoUniqueConstraintCollection* 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 UniqueConstraintCollection 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.
+ ///
UniqueConstraintCollection(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
{
}
/// \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 UniqueConstraint from this collection.
+ /// Removes the index-th UniqueConstraint from this collection.
///
/// \param index
/// Input index of the element to remove.
@@ -110,34 +172,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 UniqueConstraint object into the collection.
+ /// Adds a UniqueConstraint object into the collection.
///
/// \param value
/// Input the UniqueConstraint 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(UniqueConstraint* value);
/// \brief
- /// Determines the index of a specific UniqueConstraint object.
+ /// Determines the index of a specific UniqueConstraint object.
///
/// \param value
/// Input the UniqueConstraint 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(UniqueConstraint* value);
/// \brief
- /// Inserts a UniqueConstraint object into the collection at the specified position.
+ /// Inserts a UniqueConstraint object into the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
@@ -147,7 +209,7 @@
System::Void Insert(System::Int32 index, UniqueConstraint* value);
/// \brief
- /// Removes the first occurrence of a specific UniqueConstraint object.
+ /// Removes the first occurrence of a specific UniqueConstraint object.
///
/// \param value
/// Input the UniqueConstraint object to remove from the collection.
@@ -155,18 +217,18 @@
System::Void Remove(UniqueConstraint* value);
/// \brief
- /// Determines whether the collection contains a specific UniqueConstraint object.
+ /// Determines whether the collection contains a specific UniqueConstraint object.
///
/// \param value
/// Input The UniqueConstraint 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(UniqueConstraint* 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.
@@ -175,19 +237,49 @@
///
System::Void CopyTo(UniqueConstraint* array[],System::Int32 size);
-
/// \brief
- /// Gets or sets a UniqueConstraint in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the UniqueConstraint 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 UniqueConstraint* 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, UniqueConstraint* 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 UniqueConstraint* 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, UniqueConstraint* value);
};
More information about the fdo-commits
mailing list