[fdo-commits] r695 - in
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common: . Gml212 Io Xml Xsl
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Wed Jan 31 18:03:05 EST 2007
Author: gregboone
Date: 2007-01-31 18:03:04 -0500 (Wed, 31 Jan 2007)
New Revision: 695
Modified:
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/AssemblyVersion.cpp
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Gml212/mgSchema.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/VirtualFdoIoStream.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoByteStreamReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoCharStreamReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoFileStream.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoMemoryStream.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoStream.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoTextReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoTextWriter.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/VirtualSaxHandler.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgIXmlSaxHandler.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttribute.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttributeCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlCharDataHandler.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlCopyHandler.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlSaxContext.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlSaxHandler.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlSkipElementHandler.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlWriter.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xsl/mgXslTransformer.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgDictionary.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgDictionaryElement.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgException.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgGeometryType.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgIStreamReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgIStreamReaderImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgStringCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgStringElement.h
Log:
893057: DOC: FDO Managed API Documentation Updates
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/AssemblyVersion.cpp
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/AssemblyVersion.cpp 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/AssemblyVersion.cpp 2007-01-31 23:03:04 UTC (rev 695)
@@ -34,4 +34,4 @@
// by using the '*' as shown below:
//
-[assembly:AssemblyVersion("3.2.6108.0")];
+[assembly:AssemblyVersion("3.2.0.0")];
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Gml212/mgSchema.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Gml212/mgSchema.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Gml212/mgSchema.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -35,12 +35,14 @@
/// an XML document containing the GML 2.1.2 and Xlinks schemas.
///
/// \return
- /// Returns XmlReader
+ /// Returns a new XmlReader
///
static NAMESPACE_OSGEO_COMMON_XML::XmlReader* CreateReader();
+/// \cond DOXYGEN-IGNORE
private:
Schema(){}
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON_GML212
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/VirtualFdoIoStream.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/VirtualFdoIoStream.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/VirtualFdoIoStream.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -22,6 +22,8 @@
#include "Runtime\ProtocolExt.h"
#include "Common\Io\mgIoStream.h"
+/// \cond DOXYGEN-IGNORE
+
class VirtualFdoIoStream : public VirtualObject <NAMESPACE_OSGEO_COMMON_IO::IoStream, FdoIoStream>
{
public:
@@ -67,4 +69,5 @@
};
+/// \endcond
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoByteStreamReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoByteStreamReader.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoByteStreamReader.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -26,16 +26,15 @@
public __gc class IoStream;
/// \brief
-/// IoByteStreamReader
+/// IoByteStreamReader is an FDO reader for a Byte stream.
public __sealed __gc class IoByteStreamReader : public NAMESPACE_OSGEO_COMMON::IStreamReaderImp
{
public:
/// \brief
- /// Creates a Byte Stream reader. Reads binary data from
- /// an IoStream
+ /// Creates a Byte Stream reader. Reads binary data from an IoStream
///
/// \param stream
- /// Input the stream to read from
+ /// Input the stream to read from
///
IoByteStreamReader(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
@@ -43,14 +42,13 @@
/// Skips a number of items
///
/// \param offset
- /// Input number of items to skip
+ /// Input number of items to skip
///
System::Void Skip(System::Int32 offset);
/// \brief
- /// Reset the current index to the stream start. Allows re-reading.
+ /// Resets the current index to the stream start. Allows re-reading.
///
- ///
System::Void Reset();
/// \brief
@@ -59,23 +57,23 @@
/// enough to store data.
///
/// \param buffer
- /// Output array holding data read in.
+ /// Output array holding data read in.
+ ///
/// \param offset
- /// Input index in the array indicating the beginning of the output buffer.
- /// If zero, then the buffer is reused. If the end of the buffer, then read in
- /// appending mode. Throws "out-of-bounds" exception if not in this range.
+ /// Input index in the array indicating the beginning of the output buffer.
+ /// If zero, then the buffer is reused. If the end of the buffer, then read in
+ /// appending mode. Throws "out-of-bounds" exception if not in this range.
+ ///
/// \param count
- /// Input number of items to be read in. If -1 read the entire stream.
- /// Throws "out-of-bounds" exception if not a positive value or -1.
+ /// Input number of items to be read in. If -1 read the entire stream.
+ /// Throws "out-of-bounds" exception if not a positive value or -1.
///
/// \return
/// Returns the number of items actually read in. When 0 (zero) then the
/// end-of-stream was reached.
///
System::Int32 ReadNext(System::Byte buffer[]);
-
System::Int32 ReadNext(System::Byte buffer[], System::Int32 offset);
-
System::Int32 ReadNext(System::Byte buffer[], System::Int32 offset, System::Int32 count);
/// \brief
@@ -96,10 +94,22 @@
///
__property System::Int64 get_Index();
+ /// \brief
+ /// Constructs a stream reader based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged stream reader.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
IoByteStreamReader(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
public private:
inline FdoIoByteStreamReader* GetImpObj();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON_IO
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoCharStreamReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoCharStreamReader.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoCharStreamReader.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -27,7 +27,7 @@
public __gc class IoStream;
/// \brief
-/// IoCharStreamReader
+/// IoCharStreamReader reads items from a stream of chars.
public __sealed __gc class IoCharStreamReader : public NAMESPACE_OSGEO_COMMON::IStreamReaderImp
{
public:
@@ -35,14 +35,13 @@
/// Skips a number of items
///
/// \param offset
- /// Input number of items to skip
+ /// Input number of items to skip
///
System::Void Skip(System::Int32 offset);
/// \brief
/// Reset the current index to the stream start. Allows re-reading.
///
- ///
System::Void Reset();
/// \brief
@@ -51,23 +50,23 @@
/// enough to store data.
///
/// \param buffer
- /// Output array holding data read in.
+ /// Output array holding data read in.
+ ///
/// \param offset
- /// Input index in the array indicating the beginning of the output buffer.
- /// If zero, then the buffer is reused. If the end of the buffer, then read in
- /// appending mode. Throws "out-of-bounds" exception if not in this range.
+ /// Input index in the array indicating the beginning of the output buffer.
+ /// If zero, then the buffer is reused. If the end of the buffer, then read in
+ /// appending mode. Throws "out-of-bounds" exception if not in this range.
+ ///
/// \param count
- /// Input number of items to be read in. If -1 read the entire stream.
- /// Throws "out-of-bounds" exception if not a positive value or -1.
+ /// Input number of items to be read in. If -1 read the entire stream.
+ /// Throws "out-of-bounds" exception if not a positive value or -1.
///
/// \return
/// Returns the number of items actually read in. When 0 (zero) then the
/// end-of-stream was reached.
///
System::Int32 ReadNext(System::Char buffer[]);
-
System::Int32 ReadNext(System::Char buffer[], System::Int32 offset);
-
System::Int32 ReadNext(System::Char buffer[], System::Int32 offset, System::Int32 count);
/// \brief
@@ -76,7 +75,6 @@
/// \return
/// Returns the size of the data source in number of items
///
- ///
__property System::Int64 get_Length();
/// \brief
@@ -88,10 +86,22 @@
///
__property System::Int64 get_Index();
+ /// \brief
+ /// Constructs a stream reader based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged stream reader.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
IoCharStreamReader(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
public private:
inline FdoIStreamReaderTmpl<FdoCharacter>* GetImpObj();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON_IO
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoFileStream.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoFileStream.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoFileStream.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -33,17 +33,30 @@
/// creates the stream for a named file.
///
/// \param fileName
- /// Input the file name
+ /// Input the file name
+ ///
/// \param accessModes
- /// Input File access modes. Same as the fopen() C run-time library function
- /// (mode parameter).
+ /// Input File access modes. Same as the fopen() C run-time library function
+ /// (mode parameter).
///
IoFileStream(System::String* fileName, System::String* accessModes);
+ /// \brief
+ /// Constructs a stream reader based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged stream reader.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
IoFileStream(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
public private:
inline FdoIoFileStream* GetImpObj();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON_IO
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoMemoryStream.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoMemoryStream.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoMemoryStream.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -38,15 +38,27 @@
/// creates the memory stream. The stream manages its own storage.
///
/// \param bufferSize
- /// Input memory allocation increment. Amount of new memory to
- /// allocated when the stream needs more memory.
+ /// Input memory allocation increment. Amount of new memory to
+ /// allocated when the stream needs more memory.
///
IoMemoryStream(System::UInt32 bufferSize);
+ /// \brief
+ /// Constructs a stream based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged stream.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
IoMemoryStream(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
public private:
inline FdoIoMemoryStream* GetImpObj();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON_IO
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoStream.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoStream.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoStream.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -38,16 +38,16 @@
/// The stream’s current position is moved ahead by the number of bytes read.
///
/// \param buffer
- /// Output read into this buffer
+ /// Output read into this buffer
+ ///
/// \param count
- /// Input read this number of bytes into the buffer.
- /// The caller is responsible for allocating a buffer that is large enough to hold the bytes.
+ /// Input read this number of bytes into the buffer.
+ /// The caller is responsible for allocating a buffer that is large enough to hold the bytes.
///
/// \return
/// Returns the number of bytes that were read. 0 if already at the
/// end of the stream.
///
- ///
virtual System::UInt32 Read(System::Byte buffer[], System::UInt32 count);
/// \brief
@@ -60,9 +60,10 @@
/// if the current position is not at the end of the stream.
///
/// \param buffer
- /// Intput write from this buffer
+ /// Intput write from this buffer
+ ///
/// \param count
- /// Input number of bytes to write
+ /// Input number of bytes to write
///
virtual System::Void Write(System::Byte buffer[], System::UInt32 count);
@@ -70,14 +71,14 @@
/// reads the number of bytes from the given stream, and writes them
/// to this stream.
///
- /// \param buffer
- /// Input write from this buffer
+ /// \param stream
+ /// Input write from this buffer
+ ///
/// \param count
- /// Input the maximum number of bytes to read and write.
- /// When 0, all remaining bytes are read from the given stream.
+ /// Input the maximum number of bytes to read and write.
+ /// When 0, all remaining bytes are read from the given stream.
///
virtual System::Void Write(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
-
virtual System::Void Write(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream, System::UInt32 count);
/// \brief
@@ -88,13 +89,13 @@
/// \brief
/// skips over part of the stream.
///
- /// \param offset
- /// The number of bytes to skip. if position then
- /// the current position is moved forward. If negative, the position is
- /// moved backward. The position will remain between the start and end
- /// of the stream. The position is set to the end of the stream if the
- /// given offset would put it past the end. Similarily, the position is
- /// set to the start if the offset would put it before the start.
+ /// \param count
+ /// The number of bytes to skip. if positive then
+ /// the current position is moved forward. If negative, the position is
+ /// moved backward. The position will remain between the start and end
+ /// of the stream. The position is set to the end of the stream if the
+ /// given offset would put it past the end. Similarily, if the position is
+ /// set to the start if the offset would put it before the start.
///
virtual System::Void Skip(System::Int64 count);
@@ -102,9 +103,9 @@
/// truncates the stream to the indicated length.
///
/// \param length
- /// Input the new length (in bytes) for the stream. If this is
- /// longer than the current stream length then the stream's length
- /// is not changed.
+ /// Input the new length (in bytes) for the stream. If this is
+ /// longer than the current stream length then the stream's length
+ /// is not changed.
///
__property virtual System::Void set_Length(System::Int64 length);
@@ -122,27 +123,25 @@
///
/// \return
/// Returns the position in bytes from the start. When 0, the
- /// the position is at the start of the stream. When GetIndex() ==
- /// GetLength() the position is at the end of the stream.
+ /// the position is at the start of the stream. When Index() ==
+ /// Length() the position is at the end of the stream.
///
__property virtual System::Int64 get_Index();
/// \brief
- /// gets the reading capability.
+ /// Gets the reading capability of the stream.
///
/// \return
/// Returns true if the stream can be read.
///
- ///
__property virtual System::Boolean get_CanRead();
/// \brief
- /// gets the writing capability.
+ /// Gets the writing capability of the stream.
///
/// \return
/// Returns true if the stream can be written to.
///
- ///
__property virtual System::Boolean get_CanWrite();
/// \brief
@@ -158,6 +157,16 @@
///
__property virtual System::Boolean get_HasContext();
+ /// \brief
+ /// Constructs a stream based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged stream.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
IoStream(System::IntPtr unmanaged, System::Boolean autoDelete);
/// \brief
@@ -170,6 +179,7 @@
///
System::Void Close();
+/// \cond DOXYGEN-IGNORE
protected:
IoStream();
@@ -177,6 +187,7 @@
public private:
inline FdoIoStream* GetImpObj();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON_IO
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoTextReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoTextReader.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoTextReader.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -36,7 +36,7 @@
/// Constructs a text reader on a file
///
/// \param fileName
- /// Input name of the file to read.
+ /// Input name of the file to read.
///
IoTextReader(System::String* fileName);
@@ -44,7 +44,7 @@
/// Constructs a text reader on a stream
///
/// \param stream
- /// Input the stream to read.
+ /// Input the stream to read.
///
IoTextReader(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
@@ -60,13 +60,25 @@
///
__property NAMESPACE_OSGEO_COMMON_IO::IoStream* get_Stream();
+ /// \brief
+ /// Constructs a text reader based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged reader.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
IoTextReader(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
public private:
inline FdoIoTextReader* GetImpObj();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON_IO
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoTextWriter.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoTextWriter.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoTextWriter.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -35,12 +35,12 @@
/// Constructs a text writer on a file.
///
/// \param fileName
- /// Input name of the file to write to. The file is created
- /// if it does not yet exist. If it already exists, its previous contents are
- /// completely overwritten.
+ /// Input name of the file to write to. The file is created
+ /// if it does not yet exist. If it already exists, its previous contents are
+ /// completely overwritten.
///
/// \return
- /// Returns FdoIoTextWriter
+ /// Returns IoTextWriter
///
///
IoTextWriter(System::String* fileName);
@@ -49,11 +49,11 @@
/// Constructs a text writer on a stream.
///
/// \param stream
- /// Input the stream to write to. Writing starts at the
- /// stream's current position.
+ /// Input the stream to write to. Writing starts at the
+ /// stream's current position.
///
/// \return
- /// Returns FdoIoTextWriter
+ /// Returns IoTextWriter
///
///
IoTextWriter(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
@@ -74,7 +74,7 @@
/// Writes to this text writer. The text is written in UTF8 format.
///
/// \param data
- /// The text to write.
+ /// The text to write.
///
System::Void Write(System::String* data);
@@ -83,17 +83,29 @@
/// the text.
///
/// \param data
- /// The text to write.
+ /// The text to write.
///
System::Void WriteLine(System::String* data);
+ /// \brief
+ /// Constructs a text writer based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged writer.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
IoTextWriter(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
public private:
inline FdoIoTextWriter* GetImpObj();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON_IO
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/VirtualSaxHandler.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/VirtualSaxHandler.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/VirtualSaxHandler.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -36,6 +36,8 @@
using namespace NAMESPACE_OSGEO_COMMON_XML;
+/// \cond DOXYGEN-IGNORE
+
class VirtualSaxHandler : public VirtualObject <NAMESPACE_OSGEO_COMMON_XML::XmlSaxHandler, FdoXmlSaxHandler>
{
public:
@@ -62,4 +64,4 @@
mutable FdoInt32 wrapperCallBits;
};
-
+/// \endcond
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgIXmlSaxHandler.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgIXmlSaxHandler.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgIXmlSaxHandler.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -89,7 +89,7 @@
/// \return
/// Returning true causes the current parse to stop. Returning false
/// cause the parse to continue. Return value is ignored if the current parse
- /// is not an incremental parse ( see FdoXmlReader::Parse())
+ /// is not an incremental parse ( see XmlReader::Parse())
///
System::Boolean XmlEndElement(NAMESPACE_OSGEO_COMMON_XML::XmlSaxContext* context, System::String* resourceLocation, System::String* name, System::String* qualifiedName);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttribute.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttribute.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttribute.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -56,7 +56,7 @@
/// value is not namespace qualified.
///
/// \return
- /// Returns FdoXmlAttribute
+ /// Returns XmlAttribute
///
XmlAttribute(System::String* name, System::String* value, System::String* localName, System::String* attributeURI, System::String* prefix, System::String* valueURI, System::String* localValue, System::String* valuePrefix);
XmlAttribute(System::String* name, System::String* value, System::String* localName, System::String* attributeURI, System::String* prefix, System::String* valueURI, System::String* localValue);
@@ -66,8 +66,19 @@
XmlAttribute(System::String* name, System::String* value, System::String* localName);
XmlAttribute(System::String* name, System::String* value);
+ /// \brief
+ /// Constructs an XmlAttribute based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged attribute.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
XmlAttribute(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
protected:
virtual System::Void ReleaseUnmanagedObject();
@@ -76,6 +87,7 @@
private:
System::Void InitConstruct(String* name, String* value, String* localName, String* uri, String* prefix, String* valueUri, String* localValue, String* valuePrefix);
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON_XML
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttributeCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttributeCollection.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttributeCollection.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -31,9 +31,10 @@
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class XmlAttributeCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
+/// \cond DOXYGEN-IGNORE
private:
/// \brief
- /// nested class defined to provide Enumerator.
+ /// nested class defined to provide Enumerator.
///
__gc class Enumerator : public System::Collections::IEnumerator
{
@@ -42,19 +43,52 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param elements
+ /// Input The attribute collection to enumerate.
+ ///
Enumerator(XmlAttributeCollection* elements) : m_pCol(elements), m_nIdx(-1)
{
}
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
__property System::Object* get_Current();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element 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 string 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();
};
public private:
inline FdoXmlAttributeCollection* GetImpObj();
+
protected:
virtual System::Void ReleaseUnmanagedObject();
@@ -84,10 +118,24 @@
__property Object* System::Collections::IList::get_Item(System::Int32 index);
__property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
+/// \endcond
public:
+ /// \brief
+ /// Constructs a new empty attribute collection
+ ///
XmlAttributeCollection();
+ /// \brief
+ /// Constructs a collection based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged collection.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
XmlAttributeCollection(System::IntPtr unmanaged, System::Boolean autoDelete);
/// \brief
@@ -104,7 +152,7 @@
/// Removes the index-th XmlAttribute from this collection.
///
/// \param index
- /// Input index of the element to remove.
+ /// Input index of the element to remove.
///
System::Void RemoveAt(System::Int32 index);
@@ -117,7 +165,7 @@
/// Adds a XmlAttribute object into the collection.
///
/// \param value
- /// Input the XmlAttribute object to add.
+ /// Input the XmlAttribute object to add.
///
/// \return
/// Returns the position into which the new element was inserted.
@@ -128,22 +176,32 @@
/// Determines the index of a specific XmlAttribute object.
///
/// \param value
- /// Input the XmlAttribute object to locate in the collection.
+ /// Input the XmlAttribute 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(XmlAttribute* value);
+ /// \brief
+ /// Determines the index of a specific XmlAttribute object.
+ ///
+ /// \param value
+ /// Input the name of the XmlAttribute object to locate in the collection.
+ ///
+ /// \return
+ /// The index of value if found in the collection; otherwise, -1.
+ ///
System::Int32 IndexOf(String* name);
/// \brief
/// Inserts a XmlAttribute object into the collection at the specified position.
///
/// \param index
- /// Input the zero-based index at which value should be inserted.
+ /// Input the zero-based index at which value should be inserted.
+ ///
/// \param value
- /// Input the XmlAttribute object to insert.
+ /// Input the XmlAttribute object to insert.
///
System::Void Insert(System::Int32 index, XmlAttribute* value);
@@ -151,7 +209,7 @@
/// Removes the first occurrence of a specific XmlAttribute object.
///
/// \param value
- /// Input the XmlAttribute object to remove from the collection.
+ /// Input the XmlAttribute object to remove from the collection.
///
System::Void Remove(XmlAttribute* value);
@@ -159,22 +217,32 @@
/// Determines whether the collection contains a specific XmlAttribute object.
///
/// \param value
- /// Input The XmlAttribute object to search in the collection.
+ /// Input The XmlAttribute 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(XmlAttribute* value);
+ /// \brief
+ /// Determines whether the collection contains a specific XmlAttribute object.
+ ///
+ /// \param value
+ /// Input The name of the XmlAttribute 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.
///
/// \param array
- /// Output the one-dimensional Array that is the destination of the elements copied from this collection.
+ /// Output the one-dimensional Array that is the destination of the elements copied from this collection.
+ ///
/// \param startAt
- /// Input an integer that represents the index in array at which copying begins.
+ /// Input an integer that represents the index in array at which copying begins.
///
System::Void CopyTo(XmlAttribute* array[],System::Int32 size);
@@ -182,8 +250,11 @@
/// Gets or sets a XmlAttribute in the collection.
///
/// \param index
- /// Input index of the XmlAttribute to retrieve or set (System::Int32).
+ /// Input index of the XmlAttribute to retrieve or set (System::Int32).
///
+ /// \param value
+ /// Input the value of the XmlAttribute
+ ///
__property XmlAttribute* get_RealTypeItem(System::Int32 index);
__property System::Void set_RealTypeItem(System::Int32 index, XmlAttribute* value);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlCharDataHandler.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlCharDataHandler.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlCharDataHandler.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -36,9 +36,6 @@
/// \brief
/// Constructs a Char Data Handler.
///
- /// \return
- /// Returns FdoXmlCharDataHandler
- ///
XmlCharDataHandler();
/// \brief
@@ -50,10 +47,22 @@
///
__property System::String* get_RetString();
+ /// \brief
+ /// Constructs a DataHandler 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.
+ ///
XmlCharDataHandler(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
public private:
inline FdoXmlCharDataHandler* GetImpObj();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON_XML
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlCopyHandler.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlCopyHandler.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlCopyHandler.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -48,7 +48,7 @@
/// Input the sub-elements are written to this XML writer.
///
/// \return
- /// Returns FdoXmlCopyHandler
+ /// Returns XmlCopyHandler
///
XmlCopyHandler( NAMESPACE_OSGEO_COMMON_XML:: XmlWriter* writer );
@@ -80,10 +80,22 @@
///
NAMESPACE_OSGEO_COMMON_XML::XmlCopyHandler(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* writer, String* resourceLocation, String* name, String* qualifiedName, XmlAttributeCollection* attributes, DictionaryElementCollection* namespaces);
+ /// \brief
+ /// Constructs a CopyHandler 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.
+ ///
XmlCopyHandler(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
public private:
inline FdoXmlCopyHandler* GetImpObj();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON_XML
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlReader.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlReader.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -57,7 +57,7 @@
/// Input name of the file to read.
///
/// \return
- /// Returns FdoXmlReader
+ /// Returns XmlReader
///
XmlReader( System::String* fileName );
@@ -68,7 +68,7 @@
/// Input the stream to read.
///
/// \return
- /// Returns FdoXmlReader
+ /// Returns XmlReader
///
XmlReader(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
@@ -79,7 +79,7 @@
/// Input the text reader.
///
/// \return
- /// Returns FdoXmlReader
+ /// Returns XmlReader
///
XmlReader( NAMESPACE_OSGEO_COMMON_IO::IoTextReader* reader );
@@ -127,7 +127,7 @@
/// or the end of the document is reached. On subsequent calls to Parse() the
/// read continues where the previous call left off.
/// false: the whole document is parsed in a single call to XmlReader::Parse().
- /// The FdoXmlSaxHandler::EndElement() return value is ignored. If a previous call
+ /// The XmlSaxHandler::EndElement() return value is ignored. If a previous call
/// was made to XmlReader::Parse(), with incremental = true, then the rest of the
/// document is parsed ( the EndElement() return value is ignored ).
///
@@ -135,15 +135,12 @@
/// Returns true if the end of the document has not yet been reached
///
System::Boolean Parse();
-
System::Boolean Parse(NAMESPACE_OSGEO_COMMON_XML::IXmlSaxHandler* saxHandler);
-
System::Boolean Parse(NAMESPACE_OSGEO_COMMON_XML::IXmlSaxHandler* saxHandler, NAMESPACE_OSGEO_COMMON_XML::XmlSaxContext* saxContext);
-
System::Boolean Parse(NAMESPACE_OSGEO_COMMON_XML::IXmlSaxHandler* saxHandler, NAMESPACE_OSGEO_COMMON_XML::XmlSaxContext* saxContext, System::Boolean incremental);
/// \brief
- /// utility function that is typically called for element names or
+ /// Utility function that is typically called for element names or
/// name type attributes that were adjusted when they were written to XML.
/// FDO names that correspond to XML names, but aren't valid XML names, are
/// adjusted. This function undoes the name adjustment.
@@ -187,6 +184,7 @@
///
System::String* PrefixToUri( System::String* prefix );
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
@@ -194,6 +192,7 @@
XmlReader(System::IntPtr unmanaged, System::Boolean autoDelete);
inline FdoXmlReader* GetImpObj();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON_XML
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlSaxContext.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlSaxContext.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlSaxContext.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -39,7 +39,7 @@
/// Constructs the default Sax Context
///
/// \param reader
- /// Input the FdoXmlReader that is parsing the XML document.
+ /// Input the XmlReader that is parsing the XML document.
///
/// \return
/// Returns XmlSaxContext
@@ -47,21 +47,33 @@
XmlSaxContext(NAMESPACE_OSGEO_COMMON_XML::XmlReader* reader);
/// \brief
- /// Gets the FdoXmlReader that is parsing the XML document.
+ /// Gets the XmlReader that is parsing the XML document.
///
/// \return
/// Returns XmlReader
///
__property NAMESPACE_OSGEO_COMMON_XML::XmlReader* get_Reader();
+ /// \brief
+ /// Constructs an XmlSaxContext obhject 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.
+ ///
XmlSaxContext(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
public private:
inline FdoXmlSaxContext* GetImpObj();
};
+/// \endcond
END_NAMESPACE_OSGEO_COMMON_XML
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlSaxHandler.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlSaxHandler.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlSaxHandler.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -41,7 +41,7 @@
/// Default Sax callback that is called when the XmlReader
/// starts reading an XML document. Does nothing.
///
- /// \param saxContext
+ /// \param context
/// Input caller specified contextual information
///
/// \return
@@ -54,7 +54,7 @@
/// Default Sax callback that is called when the XmlReader
/// finishes reading an XML document. Does nothing.
///
- /// \param saxContext
+ /// \param context
/// Input caller specified contextual information
///
virtual System::Void XmlEndDocument(NAMESPACE_OSGEO_COMMON_XML::XmlSaxContext* context);
@@ -63,15 +63,15 @@
/// Default Sax callback that is called when the XmlReader
/// reads the start tag for an XML element in the document. Does nothing.
///
- /// \param saxContext
+ /// \param context
/// Input caller specified contextual information
- /// \param uri
+ /// \param resourceLocation
/// Input the element's Universal Resource Indicator
/// \param name
/// Input the unqualified element name (doesn't include namespace)
- /// \param qname
+ /// \param qualifiedName
/// Input the qualified element name (includes namespace)
- /// \param atts
+ /// \param attributes
/// Input the attributes for the element.
///
/// \return
@@ -84,13 +84,13 @@
/// Default Sax callback that is called when the XmlReader
/// reads the end tag for an XML element in the document. Does nothing.
///
- /// \param saxContext
+ /// \param context
/// Input caller specified contextual information
- /// \param uri
+ /// \param resourceLocation
/// Input the element's Universal Resource Indicator
/// \param name
/// Input the unqualified element name (doesn't include namespace)
- /// \param qname
+ /// \param qualifiedName
/// Input the qualified element name (includes namespace)
///
/// \return
@@ -107,20 +107,32 @@
/// the content is long. Applications must not make any assumptions about the
/// chunk size or number of chunks for each element
///
- /// \param saxContext
+ /// \param context
/// Input caller specified contextual information
- /// \param chars
+ /// \param characters
/// Input the next chunk of simple content
///
virtual System::Void XmlCharacters(NAMESPACE_OSGEO_COMMON_XML::XmlSaxContext* context, System::String* characters);
+ /// \brief
+ /// Constructs a SaxHandler 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.
+ ///
XmlSaxHandler(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
public private:
inline FdoXmlSaxHandler* GetImpObj();
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON_XML
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlSkipElementHandler.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlSkipElementHandler.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlSkipElementHandler.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -26,7 +26,7 @@
/// \brief
/// XmlSkipHandler can be used to skip an XML element, when reading an
-/// XML document via FdoXmlReader. It is a XmlSaxHandler with no callback
+/// XML document via XmlReader. It is a XmlSaxHandler with no callback
/// implementations. Therefore, if another XmlSaxHandler's XmlStartElement
/// callback returns a XmlSkipElementHandler then there are no more SAX events
/// until the end of the current element is reached.
@@ -41,10 +41,22 @@
///
XmlSkipElementHandler();
+ /// \brief
+ /// Constructs a XmlSkipElementHandler 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.
+ ///
XmlSkipElementHandler(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
public private:
inline FdoXmlSkipElementHandler* GetImpObj();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON_XML
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlWriter.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlWriter.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlWriter.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -75,7 +75,7 @@
/// element written (via WriteStartElement() ) becomes the root element.
/// The caller is responsible for ensuring that only one root element is written
/// (the XML standard disallows multiple root elements).
- /// \param indent
+ /// \param lineFormat
/// Input indentation string for XML elements. If NULL
/// the XML document contains no line breaks and elements are not indented.
/// if L"" then the XML document has a line break after every end element
@@ -108,7 +108,7 @@
/// element written (via WriteStartElement() ) becomes the root element.
/// The caller is responsible for ensuring that only one root element is written
/// (the XML standard disallows multiple root elements).
- /// \param indent
+ /// \param lineFormat
/// Input indentation string for XML elements. If NULL
/// the XML document contains no line breaks and elements are not indented.
/// if L"" then the XML document has a line break after every end element
@@ -133,7 +133,7 @@
/// \brief
/// Constructs an XML writer on a text writer
///
- /// \param reader
+ /// \param writer
/// Input the text writer.
/// \param defaultRoot
/// true: all elements written are wrapped in a default root element, named "DataStore".
@@ -141,7 +141,7 @@
/// element written (via WriteStartElement() ) becomes the root element.
/// The caller is responsible for ensuring that only one root element is written
/// (the XML standard disallows multiple root elements).
- /// \param indent
+ /// \param lineFormat
/// Input indentation string for XML elements. If NULL
/// the XML document contains no line breaks and elements are not indented.
/// if L"" then the XML document has a line break after every end element
@@ -223,13 +223,13 @@
/// \brief
/// Writes the end tag for the current element to the document.
- /// An FdoException is thrown if there is no element to end.
+ /// An Exception is thrown if there is no element to end.
///
System::Void WriteEndElement();
/// \brief
/// Writes an attribute to the current element.
- /// A FdoException is thrown if this function is called immediately after
+ /// An Exception is thrown if this function is called immediately after
/// WriteEndElement().
///
/// \param attributeName
@@ -243,7 +243,7 @@
/// \brief
/// Writes simple (character) content for the current element. This function
/// can be called multiple times for the same element. The characters are appended
- /// to the element's content. A FdoException is thrown if there is no current
+ /// to the element's content. An Exception is thrown if there is no current
/// element.
///
/// \param characters
@@ -285,9 +285,40 @@
///
System::Boolean IsValidName(System::String* name);
+ /// \brief
+ /// Given an element's or attribute's globally unique name ( uri and local name ),
+ /// this function returns its fully qualified name as per the
+ /// XML document being written, or the unqualified name if the uri is
+ /// the default namespace. This is done by searching for the current
+ /// namespace declaration that references the uri.
+ ///
+ /// \remarks
+ /// If a matching default namespace declaration ( "xmlns=<uri>" ) was
+ /// found and the name is for an element then the localName is returned.
+ /// \note
+ /// According to the XML 1.0 specification, default namespaces do
+ /// not apply to attribute names, so the default namespace is ignored when the
+ /// given name is not for an element.
+ /// \n
+ /// Otherwise, if a matching namespace declaration was found then
+ /// "[namespace]:[localName]" is returned.
+ /// \n
+ /// Otherwise, L"" is returned (unable to determine qualified name).
+ ///
+ /// \param location
+ /// Input the URI corresponding to an element.
+ /// \param localName
+ /// Input the local name corresponding to an element.
+ /// \param isElement
+ /// Input a boolean flag indicating that the URI corresponds to an element.
+ ///
+ /// \return
+ /// Returns the fully qualified name corresponding to the uri.
+ ///
System::String* UriToQName( System::String* location, System::String* localName, System::Boolean isElement);
System::String* UriToQName( System::String* location, System::String* localName);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
@@ -295,6 +326,7 @@
XmlWriter(System::IntPtr unmanaged, System::Boolean autoDelete);
inline FdoXmlWriter* GetImpObj();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON_XML
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xsl/mgXslTransformer.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xsl/mgXslTransformer.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xsl/mgXslTransformer.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -57,13 +57,9 @@
/// Input the logging object.
///
XslTransformer();
-
XslTransformer(NAMESPACE_OSGEO_COMMON_XML::XmlReader* inDoc);
-
XslTransformer(NAMESPACE_OSGEO_COMMON_XML::XmlReader* inDoc, NAMESPACE_OSGEO_COMMON_XML::XmlReader* stylesheet);
-
XslTransformer(NAMESPACE_OSGEO_COMMON_XML::XmlReader* inDoc, NAMESPACE_OSGEO_COMMON_XML::XmlReader* stylesheet, NAMESPACE_OSGEO_COMMON_XML::XmlWriter* outDoc);
-
XslTransformer(NAMESPACE_OSGEO_COMMON_XML::XmlReader* inDoc, NAMESPACE_OSGEO_COMMON_XML::XmlReader* stylesheet, NAMESPACE_OSGEO_COMMON_XML::XmlWriter* outDoc, NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* log);
/// \brief
@@ -150,16 +146,28 @@
///
System::Void Transform();
+ /// \brief
+ /// Constructs an XslTransformer 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.
+ ///
XslTransformer(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
{
}
+/// \cond DOXYGEN-IGNORE
public private:
inline FdoXslTransformer* GetImpObj();
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON_XSL
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgDictionary.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgDictionary.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgDictionary.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -27,29 +27,81 @@
/// \brief
/// DictionaryElementCollection is a collection of name-value pairs.
+///
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
-public __sealed __gc class DictionaryElementCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
+public __sealed __gc class DictionaryElementCollection :
+ 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
- {
+ __gc class Enumerator : public System::Collections::IEnumerator
+ {
private:
DictionaryElementCollection* m_pCol;
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new dictionary Enumerator
+ ///
+ /// \param elements
+ /// Input The Dictionary collection to enumerate.
+ ///
Enumerator(DictionaryElementCollection* elements) : m_pCol(elements), m_nIdx(-1)
{
-
}
+ /// \brief
+ /// Retrieves the current dictionay element at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current dictionary element referenced by the enumerator
+ ///
__property System::Object* get_Current();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element 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 dictionary 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();
};
@@ -82,27 +134,47 @@
__property Object* System::Collections::IList::get_Item(System::Int32 index);
__property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
+/// \endcond
public:
+ /// \brief
+ /// Constructs a new empty dictionary element collection
+ ///
DictionaryElementCollection();
+ /// \brief
+ /// Constructs a dictionary object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged collection.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
DictionaryElementCollection(System::IntPtr unmanaged, System::Boolean autoDelete);
/// \brief
/// 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.
///
+ /// \return
+ /// Returns an enumerator on the dictionary.
+ ///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
/// Removes the index-th DictionaryElement from this collection.
///
/// \param index
- /// Input index of the element to remove.
+ /// Input index of the element to remove.
///
System::Void RemoveAt(System::Int32 index);
@@ -115,10 +187,10 @@
/// Adds a DictionaryElement object into the collection.
///
/// \param value
- /// Input the DictionaryElement object to add.
+ /// Input the DictionaryElement 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(DictionaryElement* value);
@@ -126,22 +198,32 @@
/// Determines the index of a specific DictionaryElement object.
///
/// \param value
- /// Input the DictionaryElement object to locate in the collection.
+ /// Input the DictionaryElement 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(DictionaryElement* value);
+ /// \brief
+ /// Determines the index of a specific DictionaryElement object.
+ ///
+ /// \param name
+ /// Input the name of the DictionaryElement object to locate in the collection.
+ ///
+ /// \return
+ /// The index of value if found in the collection; otherwise, -1.
+ ///
System::Int32 IndexOf(String* name);
/// \brief
/// Inserts a DictionaryElement object into the collection at the specified position.
///
/// \param index
- /// Input the zero-based index at which value should be inserted.
+ /// Input the zero-based index at which value should be inserted.
+ ///
/// \param value
- /// Input the DictionaryElement object to insert.
+ /// Input the DictionaryElement object to insert.
///
System::Void Insert(System::Int32 index, DictionaryElement* value);
@@ -149,7 +231,7 @@
/// Removes the first occurrence of a specific DictionaryElement object.
///
/// \param value
- /// Input the DictionaryElement object to remove from the collection.
+ /// Input the DictionaryElement object to remove from the collection.
///
System::Void Remove(DictionaryElement* value);
@@ -157,43 +239,94 @@
/// Determines whether the collection contains a specific DictionaryElement object.
///
/// \param value
- /// Input The DictionaryElement object to search in the collection.
+ /// Input The DictionaryElement object to find 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(DictionaryElement* value);
+ /// \brief
+ /// Determines whether the collection contains a specific DictionaryElement object.
+ ///
+ /// \param value
+ /// Input The name of the DictionaryElement object to find 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.
///
/// \param array
- /// Output the one-dimensional Array that is the destination of the elements copied from this collection.
- /// \param startAt
- /// Input an integer that represents the index in array at which copying begins.
+ /// Output the one-dimensional Array that is the destination of the elements copied from this collection.
+ ///
+ /// \param size
+ /// Input an integer that represents the index in array at which copying begins.
///
System::Void CopyTo(DictionaryElement* array[],System::Int32 size);
/// \brief
- /// Gets or sets a DictionaryElement in the collection.
+ /// Gets a DictionaryElement in the collection.
///
/// \param index
- /// Input index of the DictionaryElement to retrieve or set (System::Int32).
+ /// Input index of the DictionaryElement to retrieve.
///
+ /// \return
+ /// Returns the requested dictionary element.
+ ///
__property DictionaryElement* get_RealTypeItem(System::Int32 index);
+ /// \brief
+ /// Gets a named DictionaryElement in the collection.
+ ///
+ /// \param index
+ /// Input name of the DictionaryElement to retrieve.
+ ///
+ /// \return
+ /// Returns the requested dictionary element.
+ ///
__property DictionaryElement* get_RealTypeItem(System::String* index);
+ /// \brief
+ /// Sets a DictionaryElement in the collection.
+ ///
+ /// \param index
+ /// Input The index of the DictionaryElement to set.
+ ///
+ /// \param value
+ /// The dictionary element to set at the specified index
+ ///
__property System::Void set_RealTypeItem(System::Int32 index, DictionaryElement* value);
+ /// \brief
+ /// Gets a DictionaryElement in the collection.
+ ///
+ /// \param index
+ /// Input index of the DictionaryElement to retrieve.
+ ///
+ /// \return
+ /// Returns the requested dictionary element.
+ ///
__property DictionaryElement* get_Item(System::Int32 index);
+ /// \brief
+ /// Sets a DictionaryElement in the collection.
+ ///
+ /// \param index
+ /// Input The index of the DictionaryElement to set.
+ ///
+ /// \param value
+ /// The dictionary element to set at the specified index
+ ///
__property System::Void set_Item(System::Int32 index, DictionaryElement* value);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgDictionaryElement.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgDictionaryElement.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgDictionaryElement.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -30,28 +30,44 @@
public __sealed __gc class DictionaryElement : public NAMESPACE_OSGEO_RUNTIME::Disposable
{
public:
+ /// \brief
+ /// Constructs a new empty dictionary element
+ ///
+ /// \param name
+ /// The name of the element.
+ ///
+ /// \param value
+ /// The value of the element.
+ ///
DictionaryElement(System::String* name, System::String* value);
+ /// \brief
+ /// Constructs an elemnet 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.
+ ///
DictionaryElement(System::IntPtr unmanaged, System::Boolean autoDelete);
/// \brief
- /// Gets the name of this element
+ /// Gets the name of this dictionary element
///
/// \return
- /// Returns the element name
+ /// Returns the dictionary element name
///
- ///
__property String* get_Name();
/// \brief
- /// Indicates that this object does not allow its name
- /// to change. Not allowing name change allows more efficient
- /// random access to FdoDictionary.
+ /// Indicates whether the name of the DictionaryElement can be changed once
+ /// it has been created.
///
/// \return
- /// Returns false
+ /// Returns true if the DictionaryElement name can be changed; otherwise false.
///
- ///
__property System::Boolean get_CanSetName();
/// \brief
@@ -60,22 +76,23 @@
/// \return
/// Returns the element value
///
- ///
__property System::String* get_Value();
/// \brief
/// Sets the value of this dictionary element
///
/// \param value
- /// Input the element value
+ /// Input the value of the dictionary element
///
__property System::Void set_Value(String* value);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
public private:
inline FdoDictionaryElement* GetImpObj();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgException.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgException.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgException.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -29,19 +29,22 @@
static NAMESPACE_OSGEO_COMMON::Exception* Create(System::IntPtr ex);
public:
+ /// \brief
+ /// Constructs a new empty Exception object
+ ///
NAMESPACE_OSGEO_COMMON::Exception() : System::Exception()
{
}
/// \brief
- /// Returns an instance of a FdoException using the specified arguments.
+ /// Creates an instance of an Exception using the specified arguments.
///
/// \param message
/// Input the error message
///
/// \return
- /// Returns the FdoException object
+ /// Returns the newly created Exception object
///
NAMESPACE_OSGEO_COMMON::Exception(String* msg) : System::Exception(msg)
{
@@ -49,26 +52,29 @@
}
/// \brief
- /// Returns an instance of a FdoException using the specified arguments.
+ /// Returns an instance of a Exception using the specified arguments.
///
/// \param message
/// Input the error message
+ ///
/// \param cause
/// Input the cause of the error
///
/// \return
- /// Returns the FdoException object
+ /// Returns the Exception object
///
NAMESPACE_OSGEO_COMMON::Exception(System::String* msg, System::Exception* cause) : System::Exception(msg, cause)
{
}
+/// \cond DOXYGEN-IGNORE
protected:
NAMESPACE_OSGEO_COMMON::Exception(System::Runtime::Serialization::SerializationInfo* info, System::Runtime::Serialization::StreamingContext context) : System::Exception(info, context)
{
}
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgGeometryType.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgGeometryType.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgGeometryType.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -79,7 +79,7 @@
/// \brief
/// Enumeration for components of Geometry.
/// \remarks
-/// This enumeration applies to certain helper types that are used to compose other types which derive from FdoIGeometry.
+/// This enumeration applies to certain helper types that are used to compose other types which derive from IGeometry.
/// <param name="GeometryComponentType_LinearRing">
/// LinearRing type
/// </param>
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgIStreamReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgIStreamReader.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgIStreamReader.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -22,6 +22,8 @@
BEGIN_NAMESPACE_OSGEO_COMMON
+/// \brief
+/// Enumeration for datatypes used by stream readers.
public __value enum StreamReaderType
{
StreamReaderType_Byte = FdoStreamReaderType_Byte,
@@ -29,11 +31,17 @@
};
/// \brief
-/// The IStreamReader class is a top level interface for stream reader classes.
-/// The API it provides allows the user to read large streams of data in blocks of items.
+/// The IStreamReader class is a top level interface for stream reader classes.
+/// The API it provides allows the user to read large streams of data in blocks of items.
public __gc __interface IStreamReader : public System::IDisposable
{
public:
+ /// \brief
+ /// Gets the type of the Stream Reader
+ ///
+ /// \return
+ /// Returns the Stream Reader type
+ ///
__property StreamReaderType get_Type();
};
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgIStreamReaderImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgIStreamReaderImp.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgIStreamReaderImp.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -28,18 +28,37 @@
/// \brief
/// The IStreamReader class is a top level interface for stream reader classes.
/// The API it provides allows the user to read large streams of data in blocks of items.
-public __gc class IStreamReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_COMMON::IStreamReader
+public __gc class IStreamReaderImp :
+ public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_COMMON::IStreamReader
{
public:
+ /// \brief
+ /// Constructs a IStreamReader object based on an unmanaged instance of the stream
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged Stream Reader.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed dictionary should be automatically deleted
+ /// once it no longer referenced.
+ ///
IStreamReaderImp(System::IntPtr unmanaged, System::Boolean autoDelete);
+ /// \brief
+ /// Gets the type of the Stream Reader
+ ///
+ /// \return
+ /// Returns the Stream Reader type
+ ///
__property StreamReaderType get_Type();
+/// \cond DOXYGEN-IGNORE
protected:
__sealed System::Void ReleaseUnmanagedObject();
public private:
inline FdoIStreamReader* GetImpObj();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgStringCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgStringCollection.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgStringCollection.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -30,9 +30,10 @@
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class StringCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
+/// \cond DOXYGEN-IGNORE
private:
/// \brief
- /// nested class defined to provide Enumerator.
+ /// nested class defined to provide Enumerator.
///
__gc class Enumerator : public System::Collections::IEnumerator
{
@@ -41,15 +42,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param elements
+ /// Input The String collection to enumerate.
+ ///
Enumerator(StringCollection* elements) : m_pCol(elements), m_nIdx(-1)
{
}
+ /// \brief
+ /// Retrieves the current String object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current String referenced by the enumerator
+ ///
__property System::Object* get_Current();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element 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 string 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();
};
@@ -82,46 +115,83 @@
__property Object* System::Collections::IList::get_Item(System::Int32 index);
__property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
+/// \endcond
public:
/// \brief
/// Constructs a new empty string collection
///
- /// \return
- /// Returns FdoStringCollection
- ///
- ///
StringCollection();
/// \brief
/// Creates a copy of string collection
///
/// \param src
- /// Input the source collection
+ /// Input the source collection
///
StringCollection(StringCollection* collection);
+ /// \brief
+ /// Creates a string collection that is tokenized from a string.
+ /// The collection contains an element for each token.
+ ///
+ /// \param data
+ /// Input the string to tokenize.
+ ///
+ /// \param delimiters
+ /// Input list of single character token delimiters.
+ ///
StringCollection(String* data, String* delimiters);
+ /// \brief
+ /// Creates a string collection that is tokenized from a string.
+ /// The collection contains an element for each token.
+ ///
+ /// \param data
+ /// Input the string to tokenize.
+ ///
+ /// \param delimiters
+ /// Input list of single character token delimiters.
+ ///
+ /// \param bNullTokens
+ /// true: include zero-length tokens in the collection.
+ /// false: exclude zero-length tokens
+ ///
StringCollection(String* data, String* delimiters, Boolean nullTokens);
+ /// \brief
+ /// Constructs a String Collection based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged collection.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed collection should be automatically deleted
+ /// once it no longer referenced.
+ ///
StringCollection(System::IntPtr unmanaged, System::Boolean autoDelete);
/// \brief
/// 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.
///
+ /// \return
+ /// Returns an enumerator on the dictionary.
+ ///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
/// Removes the index-th StringElement from this collection.
///
/// \param index
- /// Input index of the element to remove.
+ /// Input index of the element to remove.
///
System::Void RemoveAt(System::Int32 index);
@@ -134,10 +204,10 @@
/// Adds a StringElement object into the collection.
///
/// \param value
- /// Input the StringElement object to add.
+ /// Input the StringElement 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(StringElement* value);
@@ -145,20 +215,29 @@
/// Appends the strings from src to the end of this collection.
///
/// \param src
- /// Input the source collection
+ /// Input the source collection
///
System::Void Append(StringCollection* col);
+ /// \brief
+ /// Gets a String in the collection.
+ ///
+ /// \param index
+ /// Input index of the String to retrieve.
+ ///
+ /// \return
+ /// Returns the requested String.
+ ///
__property System::String* get_String(System::Int32 index);
/// \brief
/// Determines the index of a specific StringElement object.
///
/// \param value
- /// Input the StringElement object to locate in the collection.
+ /// Input the StringElement 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(StringElement* value);
@@ -166,9 +245,10 @@
/// Inserts a StringElement object into the collection at the specified position.
///
/// \param index
- /// Input the zero-based index at which value should be inserted.
+ /// Input the zero-based index at which value should be inserted.
+ ///
/// \param value
- /// Input the StringElement object to insert.
+ /// Input the StringElement object to insert.
///
System::Void Insert(System::Int32 index, StringElement* value);
@@ -176,7 +256,7 @@
/// Removes the first occurrence of a specific StringElement object.
///
/// \param value
- /// Input the StringElement object to remove from the collection.
+ /// Input the StringElement object to remove from the collection.
///
System::Void Remove(StringElement* value);
@@ -184,10 +264,10 @@
/// Determines whether the collection contains a specific StringElement object.
///
/// \param value
- /// Input The StringElement object to search in the collection.
+ /// Input The StringElement 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(StringElement* value);
@@ -195,28 +275,61 @@
/// Copies the elements of the collection to an array.
///
/// \param array
- /// Output the one-dimensional Array that is the destination of the elements copied from this collection.
+ /// Output the one-dimensional Array that is the destination of the elements copied from this collection.
+ ///
/// \param startAt
- /// Input an integer that represents the index in array at which copying begins.
+ /// Input an integer that represents the index in array at which copying begins.
///
System::Void CopyTo(StringElement* array[],System::Int32 size);
/// \brief
- /// Gets or sets a StringElement in the collection.
+ /// Gets a StringElement in the collection.
///
/// \param index
- /// Input index of the StringElement to retrieve or set (System::Int32).
+ /// Input index of the StringElement to retrieve.
///
+ /// \return
+ /// Returns the StringElement at the specified index
+ ///
__property StringElement* get_RealTypeItem(System::Int32 index);
+ /// \brief
+ /// Sets the value of the StringElement at the specified index
+ ///
+ /// \param index
+ /// Input index of the StringElement to set.
+ ///
+ /// \param value
+ /// Input the value of the StringElement
+ ///
__property System::Void set_RealTypeItem(System::Int32 index, StringElement* value);
+ /// \brief
+ /// Gets a StringElement in the collection.
+ ///
+ /// \param index
+ /// Input index of the StringElement to retrieve.
+ ///
+ /// \return
+ /// Returns the StringElement at the specified index
+ ///
__property StringElement* get_Item(System::Int32 index);
+ /// \brief
+ /// Sets the value of the StringElement at the specified index
+ ///
+ /// \param index
+ /// Input index of the StringElement to set.
+ ///
+ /// \param value
+ /// Input the value of the string
+ ///
__property System::Void set_Item(System::Int32 index, StringElement* value);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgStringElement.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgStringElement.h 2007-01-31 22:56:42 UTC (rev 694)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgStringElement.h 2007-01-31 23:03:04 UTC (rev 695)
@@ -29,15 +29,33 @@
public __sealed __gc class StringElement : public NAMESPACE_OSGEO_RUNTIME::Disposable
{
public:
+ /// \brief
+ /// Constructs a new string element based on an input string
+ ///
+ /// \param value
+ /// The string value of the element.
+ ///
StringElement(System::String* value);
+ /// \brief
+ /// Constructs a string elemnet based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged string element.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
StringElement(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
public private:
inline FdoStringElement* GetImpObj();
+/// \endcond
};
END_NAMESPACE_OSGEO_COMMON
More information about the fdo-commits
mailing list