[fdo-commits] r739 - branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Wed Feb 7 16:46:42 EST 2007
Author: gregboone
Date: 2007-02-07 16:46:42 -0500 (Wed, 07 Feb 2007)
New Revision: 739
Modified:
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgAssociationPropertyDefinition.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/mgDataPropertyDefinition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDataPropertyDefinitionCollection.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/mgObjectPropertyDefinition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyDefinitionCollection.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/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-07 21:45:51 UTC (rev 738)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgAssociationPropertyDefinition.h 2007-02-07 21:46:42 UTC (rev 739)
@@ -47,18 +47,24 @@
/// arguments.
///
/// \param name
- /// Input name
+ /// Input the property definition name
/// \param description
- /// Input description
+ /// Input the property definition description
+ ///
+ AssociationPropertyDefinition(System::String* name, System::String* description);
+
+ /// \brief
+ /// Constructs an instance of an AssociationPropertyDefinition using the specified
+ /// arguments.
+ ///
+ /// \param name
+ /// Input the property definition name
+ /// \param description
+ /// Input the property definition description
/// \param system
/// Input true if this is a system generated property, false otherwise.
/// <p><b>Note:</b> A client would never set system to true, only a provider.
///
- /// \return
- /// Returns AssociationPropertyDefinition
- ///
- AssociationPropertyDefinition(System::String* name, System::String* description);
-
AssociationPropertyDefinition(System::String* name, System::String* description, System::Boolean system);
/// \brief
@@ -83,9 +89,6 @@
/// \param value
/// Input class definition
///
- /// \return
- /// Returns nothing
- ///
__property System::Void set_AssociatedClass(NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition* value);
/// \brief
@@ -136,9 +139,6 @@
/// \param name
/// Input reverse name
///
- /// \return
- /// Returns nothing
- ///
__property System::Void set_ReverseName(System::String* name);
/// \brief
@@ -155,9 +155,6 @@
/// \param value
/// Input the delete rule
///
- /// \return
- /// Returns nothing
- ///
__property System::Void set_DeleteRule(NAMESPACE_OSGEO_FDO_SCHEMA::DeleteRule value);
/// \brief
@@ -174,9 +171,6 @@
/// \param value
/// Input the lock cascade option.
///
- /// \return
- /// Returns nothing
- ///
__property System::Void set_LockCascade(System::Boolean value);
/// \brief
@@ -200,9 +194,6 @@
/// \param value
/// Input the read-only flag
///
- /// \return
- /// Returns nothing.
- ///
__property System::Void set_IsReadOnly(System::Boolean value);
/// \brief
@@ -224,9 +215,6 @@
/// \param value
/// The multiplicity from the property owner class side. Valid values are: ?? or “m?
///
- /// \return
- /// Returns nothing.
- ///
__property System::Void set_Multiplicity(System::String* value);
/// \brief
@@ -247,9 +235,6 @@
/// \param value
/// The multiplicity from the associated class side. Valid values are: ?? or ??
///
- /// \return
- /// Returns nothing.
- ///
__property System::Void set_ReverseMultiplicity(System::String* value);
/// \brief
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-07 21:45:51 UTC (rev 738)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassCapabilities.h 2007-02-07 21:46:42 UTC (rev 739)
@@ -41,8 +41,7 @@
/// should only be called from an FDO Provider.
///
/// \param parent
- /// Input The FDO Class Definition that owns these
- /// capabilities.
+ /// Input The FDO Class Definition that owns these capabilities.
///
ClassCapabilities(NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition* parent);
@@ -66,9 +65,6 @@
/// \brief
/// Gets an array of LockType values supported by the feature provider.
///
- /// \param size
- /// Output the number of lock types
- ///
/// \return
/// Returns the list of lock types
///
@@ -80,8 +76,6 @@
///
/// \param types
/// The supported array of lock types
- /// \param size
- /// The number of lock types
///
__property System::Void set_LockTypes(NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::LockType types[]);
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-07 21:45:51 UTC (rev 738)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassCollection.h 2007-02-07 21:46:42 UTC (rev 739)
@@ -135,7 +135,7 @@
/// \brief
/// Constructs a ClassCollection object
///
- /// \param unmanaged
+ /// \param parent
/// Input A Pointer to the parent schema object of the collection
///
ClassCollection(NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement* parent);
@@ -240,7 +240,7 @@
/// \brief
/// Determines whether the collection contains a specific ClassDefinition object.
///
- /// \param value
+ /// \param name
/// Input The name of the ClassDefinition object to search in the collection.
///
/// \return
@@ -256,7 +256,7 @@
/// \param startAt
/// Input an integer that represents the index in array at which copying begins.
///
- System::Void CopyTo(ClassDefinition* array[],System::Int32 size);
+ System::Void CopyTo(ClassDefinition* array[],System::Int32 startAt);
/// \brief
/// Gets the item in the collection at the specified index.
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-07 21:45:51 UTC (rev 738)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgClassDefinition.h 2007-02-07 21:46:42 UTC (rev 739)
@@ -192,7 +192,7 @@
/// This function must only be called by an FDO Provider. It would be
/// typically called by the DescribeSchema command implementation.
///
- /// \param capabilities
+ /// \param value
/// Input the class capabilities.
///
__property System::Void set_Capabilities(NAMESPACE_OSGEO_FDO_SCHEMA::ClassCapabilities* value);
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-07 21:45:51 UTC (rev 738)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDataPropertyDefinition.h 2007-02-07 21:46:42 UTC (rev 739)
@@ -44,11 +44,19 @@
/// Input name
/// \param description
/// Input description
+ ///
+ DataPropertyDefinition(System::String* name, System::String* description);
+
+ /// \brief
+ /// Constructs an instance of an DataPropertyDefinition using the specified arguments
+ ///
+ /// \param name
+ /// Input name
+ /// \param description
+ /// Input description
/// \param system
/// Input true if this is a system generated property, otherwise falseds.
///
- DataPropertyDefinition(System::String* name, System::String* description);
-
DataPropertyDefinition(System::String* name, System::String* description, System::Boolean system);
/// \brief
@@ -68,7 +76,7 @@
/// \brief
/// Sets the DataType of this property.
///
- /// \param dataType
+ /// \param value
/// Input the DataType of this property
///
/// \return
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-07 21:45:51 UTC (rev 738)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgDataPropertyDefinitionCollection.h 2007-02-07 21:46:42 UTC (rev 739)
@@ -135,7 +135,7 @@
/// \brief
/// Constructs a DataPropertyDefinitionCollection object
///
- /// \param unmanaged
+ /// \param parent
/// Input A Pointer to the parent schema object of the collection
///
DataPropertyDefinitionCollection(NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement* parent);
@@ -240,7 +240,7 @@
/// \brief
/// Determines whether the collection contains a specific DataPropertyDefinition object.
///
- /// \param value
+ /// \param name
/// Input The name of the DataPropertyDefinition object to search in the collection.
///
/// \return
@@ -256,7 +256,7 @@
/// \param startAt
/// Input an integer that represents the index in array at which copying begins.
///
- System::Void CopyTo(DataPropertyDefinition* array[],System::Int32 size);
+ System::Void CopyTo(DataPropertyDefinition* array[],System::Int32 startAt);
/// \brief
/// Gets the item in the collection at the specified index.
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-07 21:45:51 UTC (rev 738)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureClassCollection.h 2007-02-07 21:46:42 UTC (rev 739)
@@ -135,7 +135,7 @@
/// \brief
/// Constructs a FeatureClassCollection object
///
- /// \param unmanaged
+ /// \param parent
/// Input A Pointer to the parent schema object of the collection
///
FeatureClassCollection(NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement* parent);
@@ -240,7 +240,7 @@
/// \brief
/// Determines whether the collection contains a specific FeatureClass object.
///
- /// \param value
+ /// \param name
/// Input The name of the FeatureClass object to search in the collection.
///
/// \return
@@ -256,7 +256,7 @@
/// \param startAt
/// Input an integer that represents the index in array at which copying begins.
///
- System::Void CopyTo(FeatureClass* array[],System::Int32 size);
+ System::Void CopyTo(FeatureClass* array[],System::Int32 startAt);
/// \brief
/// Gets the item in the collection at the specified index.
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-07 21:45:51 UTC (rev 738)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureSchema.h 2007-02-07 21:46:42 UTC (rev 739)
@@ -117,26 +117,113 @@
Implementation of XmlSerializable
*/
+ /// \brief
+ /// Writes this object to a file. A complete XML document,
+ /// containing this object, is written.
+ ///
+ /// \param fileName
+ /// Input the file name.
+ ///
System::Void WriteXml(String* fileName);
+ /// \brief
+ /// Writes this object to a file. A complete XML document,
+ /// containing this object, is written.
+ ///
+ /// \param fileName
+ /// Input the file name.
+ /// \param flags
+ /// Input controls the writing of the elements to the document.
+ /// If NULL then the default flags are used (see XmlFlags::Create())
+ ///
System::Void WriteXml(String* fileName, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
+ /// \brief
+ /// Writes to an XML writer. This object is appended to the XML document
+ /// being written. Unlike the other WriteXml() functions it is not necessarily
+ /// the only object in its document.
+ ///
+ /// \param xmlWriter
+ /// Input the XML writer. When this function completes, the
+ /// XML writer's current position will be just after this object.
+ ///
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* xmlWriter);
+ /// \brief
+ /// Writes to an XML writer. This object is appended to the XML document
+ /// being written. Unlike the other WriteXml() functions it is not necessarily
+ /// the only object in its document.
+ ///
+ /// \param xmlWriter
+ /// Input the XML writer. When this function completes, the
+ /// XML writer's current position will be just after this object.
+ /// \param flags
+ /// Input controls the writing of the elements to the writer.
+ /// If NULL then the default flags are used (see XmlFlags::Create())
+ ///
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* xmlWriter, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
+ /// \brief
+ /// Writes to a text writer. A complete XML document,
+ /// containing this object, is written.
+ ///
+ /// \param textWriter
+ /// Input the text writer.When this function completes, the
+ /// text writer's current position will be just after this object.
+ ///
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* textWriter);
+ /// \brief
+ /// Writes to a text writer. A complete XML document,
+ /// containing this object, is written.
+ ///
+ /// \param textWriter
+ /// Input the text writer.When this function completes, the
+ /// text writer's current position will be just after this object.
+ /// \param flags
+ /// Input controls the writing of the elements to the writer.
+ /// If NULL then the default flags are used (see XmlFlags::Create())
+ ///
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* textWriter, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
+ /// \brief
+ /// Writes to a stream. A complete XML document,
+ /// containing this object, is written.
+ ///
+ /// \param stream
+ /// Input the stream. When this function completes, the
+ /// stream's current position will be just after this object.
+ ///
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
+ /// \brief
+ /// Writes to a stream. A complete XML document,
+ /// containing this object, is written.
+ ///
+ /// \param stream
+ /// Input the stream. When this function completes, the
+ /// stream's current position will be just after this object.
+ /// \param flags
+ /// Input controls the writing of the elements to the stream.
+ /// If NULL then the default flags are used (see XmlFlags::Create())
+ ///
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
+ /// \brief
+ /// Gets the stylesheet for converting the XML document from
+ /// internal to external format. When classes derived from XmlSerializable
+ /// define an internal format, they must override this function to return a
+ /// stylesheet that does the conversion.
+ ///
+ /// \return
+ /// Returns NULL by default (no internal format defined)
+ ///
NAMESPACE_OSGEO_COMMON_XML::XmlReader* GetFromInternalStylesheet();
+/// \cond DOXYGEN-IGNORE
public private:
inline FdoFeatureSchema* GetImpObj();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_SCHEMA
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-07 21:45:51 UTC (rev 738)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgFeatureSchemaCollection.h 2007-02-07 21:46:42 UTC (rev 739)
@@ -150,7 +150,7 @@
/// \brief
/// Constructs a FeatureSchemaCollection object
///
- /// \param unmanaged
+ /// \param parent
/// Input A Pointer to the parent schema object of the collection
///
FeatureSchemaCollection(NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement* parent);
@@ -167,7 +167,6 @@
///
FeatureSchemaCollection(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
{
-
}
/// \brief
@@ -221,6 +220,15 @@
///
System::Int32 IndexOf(FeatureSchema* value);
+ /// \brief
+ /// Determines the index of a specific FeatureSchema object.
+ ///
+ /// \param name
+ /// Input the name of the FeatureSchema object to locate in the collection.
+ ///
+ /// \return
+ /// The index of value if found in the collection; otherwise, -1.
+ ///
System::Int32 IndexOf(String* name);
/// \brief
@@ -255,7 +263,7 @@
/// \brief
/// Determines whether the collection contains a specific FeatureSchema object.
///
- /// \param value
+ /// \param name
/// Input The name of the FeatureSchema object to search in the collection.
///
/// \return
@@ -271,7 +279,7 @@
/// \param startAt
/// Input an integer that represents the index in array at which copying begins.
///
- System::Void CopyTo(FeatureSchema* array[],System::Int32 size);
+ System::Void CopyTo(FeatureSchema* array[],System::Int32 startAt);
/// \brief
/// Gets the item in the collection at the specified index.
@@ -381,6 +389,7 @@
/*
IXmlSaxHandler Implemenations
*/
+
/// \brief
/// Default Sax callback that is called when the XmlReader
/// starts reading an XML document. Does nothing.
@@ -461,58 +470,85 @@
/*
IXmlDeserializable Implemenations
*/
+
/// \brief
/// Reads from an XML document in a file.
///
/// \param fileName
/// Input the file name. Must consist of an XML document.
+ ///
+ System::Void ReadXml(System::String* fileName);
+
+ /// \brief
+ /// Reads from an XML document in a file.
+ ///
+ /// \param fileName
+ /// Input the file name. Must consist of an XML document.
/// \param flags
/// Input controls the reading of the elements from the document.
/// If NULL then the default flags are used (see NAMESPACE_OSGEO_FDO_XML::XmlFlags::Create())
///
- System::Void ReadXml(System::String* fileName);
-
System::Void ReadXml(System::String* fileName, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
/// Reads an XML document from an XML reader.
///
- /// \param reader
+ /// \param xmlReader
/// Input the XML reader.
+ ///
+ System::Void ReadXml(NAMESPACE_OSGEO_COMMON_XML::XmlReader* xmlReader);
+
+ /// \brief
+ /// Reads an XML document from an XML reader.
+ ///
+ /// \param xmlReader
+ /// Input the XML reader.
/// \param flags
/// Input controls the reading of the elements from the document.
/// If NULL then the default flags are used (see NAMESPACE_OSGEO_FDO_XML::XmlFlags::Create())
///
- System::Void ReadXml(NAMESPACE_OSGEO_COMMON_XML::XmlReader* xmlReader);
-
System::Void ReadXml(NAMESPACE_OSGEO_COMMON_XML::XmlReader* xmlReader, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
/// Reads an XML document from a text reader.
///
- /// \param reader
+ /// \param textReader
/// Input the text reader. Must be positioned at the
/// start of an XML document.
+ ///
+ System::Void ReadXml(NAMESPACE_OSGEO_COMMON_IO::IoTextReader* textReader);
+
+ /// \brief
+ /// Reads an XML document from a text reader.
+ ///
+ /// \param textReader
+ /// Input the text reader. Must be positioned at the
+ /// start of an XML document.
/// \param flags
/// Input controls the reading of the elements from the document.
/// If NULL then the default flags are used (see NAMESPACE_OSGEO_FDO_XML::XmlFlags::Create())
///
- System::Void ReadXml(NAMESPACE_OSGEO_COMMON_IO::IoTextReader* textReader);
-
System::Void ReadXml(NAMESPACE_OSGEO_COMMON_IO::IoTextReader* textReader, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
/// Reads an XML document from a stream.
///
- /// \param reader
+ /// \param stream
/// Input the stream. Must be positioned at the
/// start of an XML document.
+ ///
+ System::Void ReadXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
+
+ /// \brief
+ /// Reads an XML document from a stream.
+ ///
+ /// \param stream
+ /// Input the stream. Must be positioned at the
+ /// start of an XML document.
/// \param flags
/// Input controls the reading of the elements from the document.
/// If NULL then the default flags are used (see NAMESPACE_OSGEO_FDO_XML::XmlFlags::Create())
///
- System::Void ReadXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
-
System::Void ReadXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
@@ -562,18 +598,26 @@
/*
IXmlSerializable Implemenations
*/
+
/// \brief
/// Writes this object to a file. A complete XML document,
/// containing this object, is written.
///
/// \param fileName
/// Input the file name.
+ ///
+ System::Void WriteXml(String* fileName);
+
+ /// \brief
+ /// Writes this object to a file. A complete XML document,
+ /// containing this object, is written.
+ ///
+ /// \param fileName
+ /// Input the file name.
/// \param flags
/// Input controls the writing of the elements to the document.
/// If NULL then the default flags are used (see XmlFlags::Create())
///
- System::Void WriteXml(String* fileName);
-
System::Void WriteXml(String* fileName, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
@@ -584,12 +628,21 @@
/// \param xmlWriter
/// Input the XML writer. When this function completes, the
/// XML writer's current position will be just after this object.
+ ///
+ System::Void WriteXml(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* xmlWriter);
+
+ /// \brief
+ /// Writes to an XML writer. This object is appended to the XML document
+ /// being written. Unlike the other WriteXml() functions it is not necessarily
+ /// the only object in its document.
+ ///
+ /// \param xmlWriter
+ /// Input the XML writer. When this function completes, the
+ /// XML writer's current position will be just after this object.
/// \param flags
/// Input controls the writing of the elements to the writer.
/// If NULL then the default flags are used (see XmlFlags::Create())
///
- System::Void WriteXml(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* xmlWriter);
-
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* xmlWriter, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
@@ -599,12 +652,20 @@
/// \param textWriter
/// Input the text writer.When this function completes, the
/// text writer's current position will be just after this object.
+ ///
+ System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* textWriter);
+
+ /// \brief
+ /// Writes to a text writer. A complete XML document,
+ /// containing this object, is written.
+ ///
+ /// \param textWriter
+ /// Input the text writer.When this function completes, the
+ /// text writer's current position will be just after this object.
/// \param flags
/// Input controls the writing of the elements to the writer.
/// If NULL then the default flags are used (see XmlFlags::Create())
///
- System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* textWriter);
-
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* textWriter, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
@@ -614,25 +675,21 @@
/// \param stream
/// Input the stream. When this function completes, the
/// stream's current position will be just after this object.
- /// \param flags
- /// Input controls the writing of the elements to the stream.
- /// If NULL then the default flags are used (see XmlFlags::Create())
///
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
- System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
-
/// \brief
- /// Gets the stylesheet for converting the XML document from
- /// internal to external format. When classes derived from XmlSerializable
- /// define an internal format, they must override this function to return a
- /// stylesheet that does the conversion.
+ /// Writes to a stream. A complete XML document,
+ /// containing this object, is written.
///
- /// \return
- /// Returns NULL by default (no internal format defined)
+ /// \param stream
+ /// Input the stream. When this function completes, the
+ /// stream's current position will be just after this object.
+ /// \param flags
+ /// Input controls the writing of the elements to the stream.
+ /// If NULL then the default flags are used (see XmlFlags::Create())
///
- /// It has beed implemented in Additional Interfaces.
- // NAMESPACE_OSGEO_COMMON_XML::XmlReader* GetFromInternalStylesheet();
+ System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
};
END_NAMESPACE_OSGEO_FDO_SCHEMA
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-07 21:45:51 UTC (rev 738)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgGeometricPropertyDefinition.h 2007-02-07 21:46:42 UTC (rev 739)
@@ -53,12 +53,21 @@
/// Input name
/// \param description
/// Input description
+ ///
+ GeometricPropertyDefinition(System::String* name, System::String* description);
+
+ /// \brief
+ /// Constructs an instance of an GeometricPropertyDefinition using the
+ /// specified arguments.
+ ///
+ /// \param name
+ /// Input name
+ /// \param description
+ /// Input description
/// \param system
/// Input true if this is a system generated property, false otherwise.
/// <p><b>Note:</b> A client would never set system to true, only a provider.
///
- GeometricPropertyDefinition(System::String* name, System::String* description);
-
GeometricPropertyDefinition(System::String* name, System::String* description, System::Boolean system);
/// \brief
@@ -87,9 +96,6 @@
/// \param value
/// Input the GeometricTypes that can be stored in this geometric property
///
- /// \return
- /// Returns nothing
- ///
__property System::Void set_GeometryTypes(System::Int32 value);
/// \brief
@@ -120,9 +126,6 @@
/// Indicates the number of geometry types being stored in the provided
/// set of geometry types.
///
- /// \return
- /// Returns nothing.
- ///
__property System::Void set_SpecificGeometryTypes(NAMESPACE_OSGEO_COMMON::GeometryType types[], System::Int32 length);
/// \brief
@@ -143,9 +146,6 @@
/// Input a Boolean value that specifies whether this geometric property is
/// read-only
///
- /// \return
- /// Returns nothing
- ///
__property System::Void set_ReadOnly(System::Boolean value);
/// \brief
@@ -166,9 +166,6 @@
/// Input a Boolean value that determines if the geometry of this property
/// includes elevation values
///
- /// \return
- /// Returns nothing
- ///
__property System::Void set_HasElevation(System::Boolean value);
/// \brief
@@ -189,9 +186,6 @@
/// Input a Boolean value that determines if the geometry of this property
/// includes measurement values
///
- /// \return
- /// Returns nothing
- ///
__property System::Void set_HasMeasure(System::Boolean value);
/// \brief
@@ -201,9 +195,6 @@
/// Input the Spatial Context name to be added/set.
/// Defaults to the active Spatial Context.
///
- /// \return
- /// Returns nothing
- ///
__property System::Void set_SpatialContextAssociation(System::String *value);
/// \brief
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-07 21:45:51 UTC (rev 738)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgObjectPropertyDefinition.h 2007-02-07 21:46:42 UTC (rev 739)
@@ -49,12 +49,21 @@
/// Input name
/// \param description
/// Input description
+ ///
+ ObjectPropertyDefinition(System::String* name, System::String* description);
+
+ /// \brief
+ /// Constructs an instance of an ObjectPropertyDefinition using the specified
+ /// arguments.
+ ///
+ /// \param name
+ /// Input name
+ /// \param description
+ /// Input description
/// \param system
/// Input true if this is a system generated property, otherwise false.
/// <p><b>Note:</b> A client would never set system to true, only a provider.
///
- ObjectPropertyDefinition(System::String* name, System::String* description);
-
ObjectPropertyDefinition(System::String* name, System::String* description, System::Boolean system);
/// \brief
@@ -73,9 +82,6 @@
/// \param value
/// Input class definition
///
- /// \return
- /// Returns nothing
- ///
__property System::Void set_Class(NAMESPACE_OSGEO_FDO_SCHEMA::ClassDefinition* value);
/// \brief
@@ -86,7 +92,7 @@
/// defines the type of this property.
///
/// \return
- /// Returns data property definition
+ /// Returns the Indentity data property definition
///
__property NAMESPACE_OSGEO_FDO_SCHEMA::DataPropertyDefinition* get_IdentityProperty();
@@ -100,9 +106,6 @@
/// \param value
/// Input data property definition
///
- /// \return
- /// Returns nothing
- ///
__property System::Void set_IdentityProperty(NAMESPACE_OSGEO_FDO_SCHEMA::DataPropertyDefinition* value);
/// \brief
@@ -121,9 +124,6 @@
/// \param value
/// Input the type of this object property
///
- /// \return
- /// Returns nothing
- ///
__property System::Void set_ObjectType(NAMESPACE_OSGEO_FDO_SCHEMA::ObjectType value);
/// \brief
@@ -144,9 +144,6 @@
/// \param value
/// Input the order type
///
- /// \return
- /// Returns nothing
- ///
__property System::Void set_OrderType(NAMESPACE_OSGEO_FDO_SCHEMA::OrderType value);
/// \brief
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-07 21:45:51 UTC (rev 738)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgPropertyDefinitionCollection.h 2007-02-07 21:46:42 UTC (rev 739)
@@ -135,7 +135,7 @@
/// \brief
/// Constructs a PropertyDefinitionCollection object
///
- /// \param unmanaged
+ /// \param parent
/// Input A Pointer to the parent schema object of the collection
///
PropertyDefinitionCollection(NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement* parent);
@@ -206,6 +206,15 @@
///
System::Int32 IndexOf(PropertyDefinition* value);
+ /// \brief
+ /// Determines the index of a specific PropertyDefinition object.
+ ///
+ /// \param name
+ /// Input the name of the PropertyDefinition object to locate in the collection.
+ ///
+ /// \return
+ /// The index of value if found in the collection; otherwise, -1.
+ ///
System::Int32 IndexOf(String* name);
/// \brief
@@ -240,7 +249,7 @@
/// \brief
/// Determines whether the collection contains a specific PropertyDefinition object.
///
- /// \param value
+ /// \param name
/// Input The name of the PropertyDefinition object to search in the collection.
///
/// \return
@@ -256,7 +265,7 @@
/// \param startAt
/// Input an integer that represents the index in array at which copying begins.
///
- System::Void CopyTo(PropertyDefinition* array[],System::Int32 size);
+ System::Void CopyTo(PropertyDefinition* array[],System::Int32 startAt);
/// \brief
/// Gets the item in the collection at the specified index.
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-07 21:45:51 UTC (rev 738)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgRasterPropertyDefinition.h 2007-02-07 21:46:42 UTC (rev 739)
@@ -50,12 +50,21 @@
/// Input name
/// \param description
/// Input description
+ ///
+ RasterPropertyDefinition(System::String* name, System::String* description);
+
+ /// \brief
+ /// Constructs an instance of an RasterPropertyDefinition using the
+ /// specified arguments.
+ ///
+ /// \param name
+ /// Input name
+ /// \param description
+ /// Input description
/// \param system
/// Input true if this is a system generated property, false otherwise.
/// <p><b>Note:</b> A client would never set system to true, only a provider.
///
- RasterPropertyDefinition(System::String* name, System::String* description);
-
RasterPropertyDefinition(System::String* name, System::String* description, System::Boolean system);
//
@@ -116,11 +125,11 @@
/// Allowed values are only those data models that are acceptable to the
/// SupportsDataModel capability.
///
- /// \param datamodel
+ /// \param dataModel
/// The datamodel to be used for newly created
/// rasters, or the default datamodel to be used when returning raster data.
///
- __property System::Void set_DefaultDataModel (NAMESPACE_OSGEO_FDO_RASTER::RasterDataModel* value);
+ __property System::Void set_DefaultDataModel (NAMESPACE_OSGEO_FDO_RASTER::RasterDataModel* dataModel);
/// \brief
/// Gets the default size of image file in the horizontal
@@ -140,7 +149,7 @@
/// The desired default horizontal image size in pixels
/// (number of columns).
///
- __property System::Void set_DefaultImageXSize (System::Int32 value);
+ __property System::Void set_DefaultImageXSize (System::Int32 size);
/// \brief
/// Gets the default size of an image file in the vertical
@@ -160,7 +169,7 @@
/// The desired default vertical image size in pixels
/// (number of rows).
///
- __property System::Void set_DefaultImageYSize (System::Int32 value);
+ __property System::Void set_DefaultImageYSize (System::Int32 size);
//
/// Spatial Context Support.
@@ -169,7 +178,7 @@
/// \brief
/// Sets a Spatial Context association for this raster property.
///
- /// \param value
+ /// \param spatialContextName
/// Input the Spatial Context name to be set.
/// Defaults to the active Spatial Context.
///
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-07 21:45:51 UTC (rev 738)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgReadOnlyDataPropertyDefinitionCollection.h 2007-02-07 21:46:42 UTC (rev 739)
@@ -122,7 +122,7 @@
/// \brief
/// Constructs a ReadOnlyDataPropertyDefinitionCollection object
///
- /// \param unmanaged
+ /// \param parent
/// Input A Pointer to the parent schema object of the collection
///
ReadOnlyDataPropertyDefinitionCollection(NAMESPACE_OSGEO_FDO_SCHEMA::DataPropertyDefinitionCollection* parent);
@@ -188,7 +188,7 @@
/// \param startAt
/// Input an integer that represents the index in array at which copying begins.
///
- System::Void CopyTo(NAMESPACE_OSGEO_FDO_SCHEMA::DataPropertyDefinition* array[],System::Int32 index);
+ System::Void CopyTo(NAMESPACE_OSGEO_FDO_SCHEMA::DataPropertyDefinition* array[],System::Int32 startAt);
/// \brief
/// Gets the item in the collection at the specified index.
@@ -202,6 +202,16 @@
///
__property NAMESPACE_OSGEO_FDO_SCHEMA::DataPropertyDefinition* get_RealTypeItem(System::Int32 index);
+ /// \brief
+ /// Gets the DataPropertyDefinition item in the collection at the specified index.
+ ///
+ /// \param name
+ /// The name of the DataPropertyDefinition item in the collection.
+ ///
+ /// \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::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-07 21:45:51 UTC (rev 738)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgReadOnlyPropertyDefinitionCollection.h 2007-02-07 21:46:42 UTC (rev 739)
@@ -122,7 +122,7 @@
/// \brief
/// Constructs a ReadOnlyPropertyDefinitionCollection object
///
- /// \param unmanaged
+ /// \param parent
/// Input A Pointer to the parent schema object of the collection
///
ReadOnlyPropertyDefinitionCollection(NAMESPACE_OSGEO_FDO_SCHEMA::PropertyDefinitionCollection* parent);
@@ -188,7 +188,7 @@
/// \param startAt
/// Input an integer that represents the index in array at which copying begins.
///
- System::Void CopyTo(NAMESPACE_OSGEO_FDO_SCHEMA::PropertyDefinition* array[],System::Int32 index);
+ System::Void CopyTo(NAMESPACE_OSGEO_FDO_SCHEMA::PropertyDefinition* array[],System::Int32 startAt);
/// \brief
/// Gets the item in the collection at the specified index.
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-07 21:45:51 UTC (rev 738)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgSchemaAttributeDictionary.h 2007-02-07 21:46:42 UTC (rev 739)
@@ -41,9 +41,6 @@
/// \brief
/// Gets an array containing all of the attribute names in the dictionary.
///
- /// \param length
- /// Output number of attribute names
- ///
/// \return
/// Returns an array containing all of the attribute names in the dictionary
///
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-07 21:45:51 UTC (rev 738)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgSchemaElement.h 2007-02-07 21:46:42 UTC (rev 739)
@@ -37,7 +37,7 @@
/// been added to a parent object.
///
/// \return
- /// Returns SchemaElement of parent
+ /// Returns the SchemaElement of the parent
///
__property NAMESPACE_OSGEO_FDO_SCHEMA::SchemaElement* get_Parent();
@@ -89,19 +89,14 @@
/// \param value
/// Input the name of the schema object
///
- /// \return
- /// Returns nothing
- ///
__property System::Void set_Name(System::String* value);
/// \brief
- /// Sets the name of the schema object.
+ /// Indicates whether the name of the Element can be changed once
+ /// it has been created.
///
- /// \param value
- /// Input the name of the schema object
- ///
/// \return
- /// Returns nothing
+ /// Returns true if the Element name can be changed; otherwise false.
///
__property System::Boolean get_CanSetName();
@@ -119,9 +114,6 @@
/// \param value
/// Input the description of the schema object
///
- /// \return
- /// Returns nothing
- ///
__property System::Void set_Description(System::String* value);
/// \brief
@@ -131,9 +123,6 @@
/// the current state is SchemaElementState_Detached this method does
/// nothing.
///
- /// \return
- /// Returns nothing
- ///
System::Void Delete();
/// \brief
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-07 21:45:51 UTC (rev 738)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Schema/mgUniqueConstraintCollection.h 2007-02-07 21:46:42 UTC (rev 739)
@@ -235,7 +235,7 @@
/// \param startAt
/// Input an integer that represents the index in array at which copying begins.
///
- System::Void CopyTo(UniqueConstraint* array[],System::Int32 size);
+ System::Void CopyTo(UniqueConstraint* array[],System::Int32 startAt);
/// \brief
/// Gets the item in the collection at the specified index.
More information about the fdo-commits
mailing list