[fdo-commits] r736 -
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Wed Feb 7 16:44:29 EST 2007
Author: gregboone
Date: 2007-02-07 16:44:29 -0500 (Wed, 07 Feb 2007)
New Revision: 736
Modified:
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgBLOBValue.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgDataValue.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgDataValueCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgExpressionCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgFunction.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgIdentifier.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgLOBValue.h
Log:
893057: DOC: FDO Managed API Documentation Updates
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgBLOBValue.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgBLOBValue.h 2007-02-07 21:43:19 UTC (rev 735)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgBLOBValue.h 2007-02-07 21:44:29 UTC (rev 736)
@@ -55,16 +55,50 @@
///
BLOBValue(System::Byte value []);
+ /// \brief
+ /// Gets the FDO DataType of the BLOB
+ ///
+ /// \return
+ /// Returns the FDO DataType
+ ///
__property NAMESPACE_OSGEO_FDO_SCHEMA::DataType get_DataType();
+ /// \brief
+ /// Gets the data associated to the blob as an Byte Array
+ ///
+ /// \return
+ /// Returns the Byte Array containing the BLOB data
+ ///
__property System::Byte get_Data() [];
+ /// \brief
+ /// Sets the data associated to the BLOB using an FDO ByteArray
+ ///
+ /// \param value
+ /// Input the FDO Byte Array
+ ///
__property System::Void set_Data(System::Byte value []);
+ /// \brief
+ /// Sets the value of the BLOB to NULL.
+ ///
System::Void SetNull();
+ /// \brief
+ /// Overrides FdoIExpression::Process to pass the DataValue to the appropriate
+ /// expression processor operation.
+ ///
+ /// \param processor
+ /// Input the pointer to the FDO expression processor
+ ///
System::Void Process(NAMESPACE_OSGEO_FDO_EXPRESSION::IExpressionProcessor* processor);
+ /// \brief
+ /// Gets the value of the BLOB as a string.
+ ///
+ /// \return
+ /// Returns the well defined text representation of the BLOB
+ ///
System::String* ToString();
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgDataValue.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgDataValue.h 2007-02-07 21:43:19 UTC (rev 735)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgDataValue.h 2007-02-07 21:44:29 UTC (rev 736)
@@ -149,8 +149,7 @@
///
/// \param value
/// Input a byte array
- /// \param length
- /// Input the length of the byte array
+ ///
/// \param dataType
/// Input the type of value to create
///
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgDataValueCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgDataValueCollection.h 2007-02-07 21:43:19 UTC (rev 735)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgDataValueCollection.h 2007-02-07 21:44:29 UTC (rev 736)
@@ -230,10 +230,11 @@
///
/// \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.
///
- System::Void CopyTo(NAMESPACE_OSGEO_FDO_EXPRESSION::DataValue* array[],System::Int32 size);
+ System::Void CopyTo(NAMESPACE_OSGEO_FDO_EXPRESSION::DataValue* 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/Expression/mgExpressionCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgExpressionCollection.h 2007-02-07 21:43:19 UTC (rev 735)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgExpressionCollection.h 2007-02-07 21:44:29 UTC (rev 736)
@@ -230,10 +230,11 @@
///
/// \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.
///
- System::Void CopyTo(NAMESPACE_OSGEO_FDO_EXPRESSION::Expression* array[],System::Int32 size);
+ System::Void CopyTo(NAMESPACE_OSGEO_FDO_EXPRESSION::Expression* 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/Expression/mgFunction.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgFunction.h 2007-02-07 21:43:19 UTC (rev 735)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgFunction.h 2007-02-07 21:44:29 UTC (rev 736)
@@ -49,8 +49,6 @@
/// Input name of the function
/// \param arguments
/// Input pointer to arguments
- /// \param numArgs
- /// Input number of arguments
///
/// \return
/// Returns Function
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgIdentifier.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgIdentifier.h 2007-02-07 21:43:19 UTC (rev 735)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgIdentifier.h 2007-02-07 21:44:29 UTC (rev 736)
@@ -87,9 +87,6 @@
/// \brief
/// Gets the scope of the identifier as an array of strings.
///
- /// \param length
- /// Output number of strings
- ///
/// \return
/// Returns scope as array of strings
///
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgLOBValue.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgLOBValue.h 2007-02-07 21:43:19 UTC (rev 735)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Expression/mgLOBValue.h 2007-02-07 21:44:29 UTC (rev 736)
@@ -37,8 +37,11 @@
{
public:
/// \brief
- /// A cast operator to get the BLOB value.
+ /// Transforms the FDO LOB value into a byte array.
///
+ /// \param value
+ /// Input an FDO LOBValue object
+ ///
/// \return
/// Returns a byte array
///
@@ -53,7 +56,7 @@
__property NAMESPACE_OSGEO_FDO_SCHEMA::DataType get_DataType();
/// \brief
- /// Gets the LOB value.
+ /// Gets the LOB data.
///
/// \return
/// Returns a byte array
@@ -61,7 +64,7 @@
__property System::Byte get_Data() [];
/// \brief
- /// Sets the LOB value.
+ /// Sets the LOB data.
///
/// \param value
/// Input an array of bytes
More information about the fdo-commits
mailing list