[fdo-commits] r707 - branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Thu Feb 1 19:58:17 EST 2007
Author: gregboone
Date: 2007-02-01 19:58:17 -0500 (Thu, 01 Feb 2007)
New Revision: 707
Modified:
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgBinaryLogicalOperations.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgBinaryLogicalOperator.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgComparisonCondition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgComparisonOperations.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgConditionType.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgDistanceCondition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgDistanceOperations.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgFilter.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgGeometricCondition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgIFilterProcessor.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgIFilterProcessorImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgInCondition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgLogicalOperator.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgNullCondition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgSearchCondition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgSpatialCondition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgSpatialOperations.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgUnaryLogicalOperations.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgUnaryLogicalOperator.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgValueExpressionCollection.h
Log:
893057: DOC: FDO Managed API Documentation Updates
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgBinaryLogicalOperations.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgBinaryLogicalOperations.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgBinaryLogicalOperations.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -21,12 +21,12 @@
BEGIN_NAMESPACE_OSGEO_FDO_FILTER
/// \brief
-/// The FdoBinaryLogicalOperations enumeration lists the binary logical operations
+/// The BinaryLogicalOperations enumeration lists the binary logical operations
/// available.
-/// <param name="FdoBinaryLogicalOperations_And">
+/// <param name="BinaryLogicalOperations_And">
/// Perform a logical And between the two filters
/// </param>
-/// <param name="FdoBinaryLogicalOperations_Or">
+/// <param name="BinaryLogicalOperations_Or">
/// Perform a logical Or between the two filters
/// </param>
[System::FlagsAttribute]
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgBinaryLogicalOperator.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgBinaryLogicalOperator.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgBinaryLogicalOperator.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -28,21 +28,21 @@
public __gc __interface IFilterProcessor;
/// \brief
-/// The FdoBinaryLogicalOperator class derives from FdoLogicalOperator and allows two
+/// The BinaryLogicalOperator class derives from LogicalOperator and allows two
/// filters to be combined via a logical "and" or a logical "or".
public __gc class BinaryLogicalOperator : public NAMESPACE_OSGEO_FDO_FILTER::LogicalOperator
{
public:
/// \brief
- /// Constructs a default instance of an FdoBinaryLogicalOperator.
+ /// Constructs a default instance of an BinaryLogicalOperator.
///
/// \return
- /// Returns FdoBinaryLogicalOperator
+ /// Returns BinaryLogicalOperator
///
BinaryLogicalOperator();
/// \brief
- /// Constructs an instance of an FdoBinaryLogicalOperator using the specified arguments.
+ /// Constructs an instance of an BinaryLogicalOperator using the specified arguments.
///
/// \param leftOperand
/// Input left hand operand
@@ -52,7 +52,7 @@
/// Input right hand operand
///
/// \return
- /// Returns FdoBinaryLogicalOperator
+ /// Returns BinaryLogicalOperator
///
BinaryLogicalOperator(NAMESPACE_OSGEO_FDO_FILTER::Filter* leftOperand, NAMESPACE_OSGEO_FDO_FILTER::BinaryLogicalOperations operation, NAMESPACE_OSGEO_FDO_FILTER::Filter* rightOperand);
@@ -114,7 +114,7 @@
__property System::Void set_RightOperand(NAMESPACE_OSGEO_FDO_FILTER::Filter* value);
/// \brief
- /// Overrides FdoFilter.Process to pass the FdoBinaryLogicalOperator to the
+ /// Overrides Filter.Process to pass BinaryLogicalOperator to the
/// appropriate filter processor operation.
///
/// \param processor
@@ -125,6 +125,16 @@
///
System::Void Process(NAMESPACE_OSGEO_FDO_FILTER::IFilterProcessor* processor);
+ /// \brief
+ /// Constructs a BinaryLogicalOperator object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
BinaryLogicalOperator(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgComparisonCondition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgComparisonCondition.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgComparisonCondition.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -33,17 +33,17 @@
public __gc __interface IFilterProcessor;
/// \brief
-/// The FdoComparisonCondition class derives from FdoSearchCondition and can be used
+/// The ComparisonCondition class derives SearchCondition and can be used
/// to test the equality of two expressions.
public __gc class ComparisonCondition : public NAMESPACE_OSGEO_FDO_FILTER::SearchCondition
{
public:
/// \brief
- /// Constructs a default instance of an FdoComparisonCondition.
+ /// Constructs a default instance of an ComparisonCondition.
///
/// \return
- /// Returns FdoComparisonCondition
+ /// Returns ComparisonCondition
///
ComparisonCondition();
@@ -58,7 +58,7 @@
/// Input the expression that defines the right side of the comparison
///
/// \return
- /// Returns FdoComparisonCondition
+ /// Returns ComparisonCondition
///
ComparisonCondition( NAMESPACE_OSGEO_FDO_EXPRESSION::Expression* leftExpression, NAMESPACE_OSGEO_FDO_FILTER::ComparisonOperations operation, NAMESPACE_OSGEO_FDO_EXPRESSION::Expression* rightExpression);
@@ -120,7 +120,7 @@
__property System::Void set_RightExpression( NAMESPACE_OSGEO_FDO_EXPRESSION::Expression* value);
/// \brief
- /// Overrides FdoFilter.Process to pass the FdoComparisonCondition to the
+ /// Overrides Filter.Process to pass ComparisonCondition to the
/// appropriate filter processor operation.
///
/// \param processor
@@ -131,6 +131,16 @@
///
System::Void Process(NAMESPACE_OSGEO_FDO_FILTER::IFilterProcessor* processor);
+ /// \brief
+ /// Constructs a ComparisonCondition object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
ComparisonCondition(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgComparisonOperations.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgComparisonOperations.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgComparisonOperations.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -21,21 +21,21 @@
BEGIN_NAMESPACE_OSGEO_FDO_FILTER
/// \brief
-/// The FdoComparisonOperations enumeration lists the comparison operations
+/// The ComparisonOperations enumeration lists the comparison operations
/// available.
-/// \param FdoComparisonOperations_EqualTo
+/// \param ComparisonOperations_EqualTo
/// Test to see if the left and right expressions are equal
-/// \param FdoComparisonOperations_NotEqualTo
+/// \param ComparisonOperations_NotEqualTo
/// Test to see if the left and right expressions are not equal
-/// \param FdoComparisonOperations_GreaterThan
+/// \param ComparisonOperations_GreaterThan
/// Test to see if the left expression is greater than the right expression
-/// \param FdoComparisonOperations_GreaterThanOrEqualTo
+/// \param ComparisonOperations_GreaterThanOrEqualTo
/// Test to see if the left expression is greater than or equal to the right expression
-/// \param FdoComparisonOperations_LessThan
+/// \param ComparisonOperations_LessThan
/// Test to see if the left expression is less than the right expression
-/// \param FdoComparisonOperations_LessThanOrEqualTo
+/// \param ComparisonOperations_LessThanOrEqualTo
/// Test to see if the left expression is less than or equal to the right expression
-/// \param FdoComparisonOperations_Like
+/// \param ComparisonOperations_Like
/// Test to see if the left expression matches the pattern specified by the
/// right expression. Wildcard characters supported in the pattern are:
///
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgConditionType.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgConditionType.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgConditionType.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -21,27 +21,27 @@
BEGIN_NAMESPACE_OSGEO_FDO_FILTER
/// \brief
-/// The FdoConditionType enumeration defines the filter condition types available.
+/// The ConditionType enumeration defines the filter condition types available.
/// This enumeration is used in the capabilities.
-/// <param name="FdoConditionType_Comparison">
+/// <param name="ConditionType_Comparison">
/// Tests if one expression is equal, not equal, greater than, less than,
/// greater than or equal to, or less than or equal to another expression
/// </param>
-/// <param name="FdoConditionType_Like">
+/// <param name="ConditionType_Like">
/// Tests if the value of a specified data property matches a specified pattern
/// </param>
-/// <param name="FdoConditionType_In">
+/// <param name="ConditionType_In">
/// Tests if the value of a specified data property is within a given set
/// of literal values
/// </param>
-/// <param name="FdoConditionType_Null">
+/// <param name="ConditionType_Null">
/// Tests if the value of a specified data property is null
/// </param>
-/// <param name="FdoConditionType_Spatial">
+/// <param name="ConditionType_Spatial">
/// Tests whether the value of a geometric property and a literal geometric
/// value satisfy the spatial relationship implied by the operation
/// </param>
-/// <param name="FdoConditionType_Distance">
+/// <param name="ConditionType_Distance">
/// Tests whether the value of a geometric property is within or beyond a
/// specified distance of a literal geometric value
/// </param>
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgDistanceCondition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgDistanceCondition.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgDistanceCondition.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -34,7 +34,7 @@
public __gc __interface IFilterProcessor;
/// \brief
-/// The FdoDistanceCondition class derives from FdoGeometricCondition and can be used
+/// The DistanceCondition class derives GeometricCondition and can be used
/// to test whether the value of a geometric property is within or beyond a
/// specified distance of the specified geometric value. Some feature providers
/// may only support literal geometric values; if so, the provider's capabilities
@@ -44,15 +44,15 @@
public:
/// \brief
- /// Constructs a default instance of an FdoDistanceCondition.
+ /// Constructs a default instance of an DistanceCondition.
///
/// \return
- /// Returns FdoDistanceCondition
+ /// Returns DistanceCondition
///
DistanceCondition();
/// \brief
- /// Constructs an instance of an FdoDistanceCondition using the specified arguments.
+ /// Constructs an instance of an DistanceCondition using the specified arguments.
///
/// \param propertyName
/// Input property name
@@ -64,12 +64,12 @@
/// Input distance
///
/// \return
- /// Returns FdoDistanceCondition
+ /// Returns DistanceCondition
///
DistanceCondition(System::String* propertyName, NAMESPACE_OSGEO_FDO_FILTER::DistanceOperations operation, NAMESPACE_OSGEO_FDO_EXPRESSION::Expression* geometry, System::Double distance);
/// \brief
- /// Constructs an instance of an FdoDistanceCondition using the specified arguments.
+ /// Constructs an instance of an DistanceCondition using the specified arguments.
///
/// \param propertyName
/// Input property name
@@ -81,7 +81,7 @@
/// Input distance
///
/// \return
- /// Returns FdoDistanceCondition
+ /// Returns DistanceCondition
///
DistanceCondition(NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* propertyName, NAMESPACE_OSGEO_FDO_FILTER::DistanceOperations operation, NAMESPACE_OSGEO_FDO_EXPRESSION::Expression* geometry, System::Double distance);
@@ -143,7 +143,7 @@
__property System::Void set_Distance( System::Double value);
/// \brief
- /// Overrides FdoFilter.Process to pass the FdoDistanceCondition to the
+ /// Overrides Filter.Process to pass DistanceCondition to the
/// appropriate filter processor operation.
///
/// \param processor
@@ -154,6 +154,16 @@
///
System::Void Process(NAMESPACE_OSGEO_FDO_FILTER::IFilterProcessor* processor);
+ /// \brief
+ /// Constructs a DistanceCondition object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
DistanceCondition(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgDistanceOperations.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgDistanceOperations.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgDistanceOperations.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -21,12 +21,12 @@
BEGIN_NAMESPACE_OSGEO_FDO_FILTER
/// \brief
-/// The FdoDistanceOperations enumeration lists the distance conditions available.
-/// <param name="FdoDistanceOperations_Beyond">
+/// The DistanceOperations enumeration lists the distance conditions available.
+/// <param name="DistanceOperations_Beyond">
/// Test to see if the geometric property value lies beyond a specified
/// distance of a literal geometric value
/// </param>
-/// <param name="FdoDistanceOperations_Within">
+/// <param name="DistanceOperations_Within">
/// Test to see if the geometric property value lies within a specified
/// distance of a literal geometric value
/// </param>
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgFilter.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgFilter.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgFilter.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -26,8 +26,8 @@
public __gc __interface IFilterProcessor;;
/// \brief
-/// The FdoFilter abstract class is a base class for condition and operator classes
-/// that can occur in a filter expression tree. The FdoFilter class contains
+/// Filter is an abstract class which acts as a base class for condition and operator classes
+/// that can occur in a filter expression tree. The Filter class contains
/// operations for converting between the text and expression tree representation
/// of a filter.
public __gc class Filter : public NAMESPACE_OSGEO_RUNTIME::Disposable
@@ -46,7 +46,7 @@
static NAMESPACE_OSGEO_FDO_FILTER::Filter* Parse(System::String* filterText);
/// \brief
- /// Abstract operation that takes an FdoIFilterProcessor as an argument.
+ /// Abstract operation that takes an IFilterProcessor as an argument.
/// Concrete filter subclasses must override this method and pass themselves
/// as an argument to the appropriate filter processor operation.
///
@@ -131,13 +131,25 @@
///
NAMESPACE_OSGEO_FDO_FILTER::Filter* Combine(System::String* leftFilter, NAMESPACE_OSGEO_FDO_FILTER::BinaryLogicalOperations operation, System::String* rightFilter);
+ /// \brief
+ /// Constructs a Filter object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
Filter(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
inline FdoFilter* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_FILTER
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgGeometricCondition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgGeometricCondition.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgGeometricCondition.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -31,10 +31,10 @@
BEGIN_NAMESPACE_OSGEO_FDO_FILTER
/// \brief
-/// The FdoGeometricCondition abstract class derives from FdoSearchCondition and can
+/// GeometricCondition is an abstract class that derives from SearchCondition and can
/// be used to test whether the value of a geometric property meets a particular
-/// spatial criteria. FdoGeometricCondition is the base class for FdoDistanceCondition
-/// and FdoSpatialCondition.
+/// spatial criteria. GeometricCondition is the base class for DistanceCondition
+/// and SpatialCondition.
public __gc class GeometricCondition : public NAMESPACE_OSGEO_FDO_FILTER::SearchCondition
{
public:
@@ -57,6 +57,16 @@
///
__property System::Void set_PropertyName(NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* value);
+ /// \brief
+ /// Constructs a GeometricCondition object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
GeometricCondition(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgIFilterProcessor.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgIFilterProcessor.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgIFilterProcessor.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -21,7 +21,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_FILTER
/// \brief
-/// The FdoIFilterProcessor interface can be used to process the nodes in a filter
+/// The IFilterProcessor interface can be used to process the nodes in a filter
/// tree. It declares a process operation for each concrete class in the filter
/// hierarchy. Providers or client applications can create classes that realize
/// this interface to do something meaningful with a filter hierarchy. For
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgIFilterProcessorImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgIFilterProcessorImp.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgIFilterProcessorImp.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -25,7 +25,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_FILTER
/// \brief
-/// The FdoIFilterProcessor interface can be used to process the nodes in a filter
+/// The IFilterProcessor interface can be used to process the nodes in a filter
/// tree. It declares a process operation for each concrete class in the filter
/// hierarchy. Providers or client applications can create classes that realize
/// this interface to do something meaningful with a filter hierarchy. For
@@ -34,13 +34,25 @@
private __gc class IFilterProcessorImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_FILTER::IFilterProcessor
{
public:
+ /// \brief
+ /// Constructs a IFilterProcessorImp object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
IFilterProcessorImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
inline FdoIFilterProcessor* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_FILTER
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgInCondition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgInCondition.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgInCondition.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -36,22 +36,22 @@
public __gc class ValueExpressionCollection;
/// \brief
-/// The FdoInCondition class derives from FdoSearchCondition and can be used to test
+/// The InCondition class derives from SearchCondition and can be used to test
/// if the value of a specified data property is within a given set of literal
/// values.
public __gc class InCondition : public NAMESPACE_OSGEO_FDO_FILTER::SearchCondition
{
public:
/// \brief
- /// Constructs a default instance of an FdoInCondition.
+ /// Constructs a default instance of an InCondition.
///
/// \return
- /// Returns FdoInCondition
+ /// Returns InCondition
///
InCondition();
/// \brief
- /// Constructs an instance of an FdoInCondition using the specified arguments.
+ /// Constructs an instance of an InCondition using the specified arguments.
///
/// \param propertyName
/// Input property name
@@ -61,12 +61,12 @@
/// Input number of values
///
/// \return
- /// Returns FdoInCondition
+ /// Returns InCondition
///
InCondition(System::String* propertyName, System::String* values []);
/// \brief
- /// Constructs an instance of an FdoInCondition using the specified arguments.
+ /// Constructs an instance of an InCondition using the specified arguments.
///
/// \param propertyName
/// Input property name
@@ -76,12 +76,12 @@
/// Input number of values
///
/// \return
- /// Returns FdoInCondition
+ /// Returns InCondition
///
InCondition(NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* propertyName, System::String* values []);
/// \brief
- /// Constructs an instance of an FdoInCondition using the specified arguments.
+ /// Constructs an instance of an InCondition using the specified arguments.
///
/// \param propertyName
/// Input property name
@@ -89,7 +89,7 @@
/// Input collection of values
///
/// \return
- /// Returns FdoInCondition
+ /// Returns InCondition
///
InCondition(NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* propertyName, NAMESPACE_OSGEO_FDO_FILTER::ValueExpressionCollection* collection);
@@ -113,15 +113,15 @@
__property System::Void set_PropertyName(NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* value);
/// \brief
- /// Gets the FdoLiteralCollection that contains the literal values.
+ /// Gets LiteralCollection that contains the literal values.
///
/// \return
- /// Returns FdoValueExpressionCollection
+ /// Returns ValueExpressionCollection
///
__property NAMESPACE_OSGEO_FDO_FILTER::ValueExpressionCollection* get_Values();
/// \brief
- /// Overrides FdoFilter.Process to pass the FdoInCondition to the appropriate
+ /// Overrides Filter.Process to pass InCondition to the appropriate
/// filter processor operation.
///
/// \param processor
@@ -140,6 +140,16 @@
///
System::String* ToStringInternal( NAMESPACE_OSGEO_FDO_COMMANDS::IdentifierCollection *idCollection );
+ /// \brief
+ /// Constructs a InCondition object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
InCondition(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgLogicalOperator.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgLogicalOperator.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgLogicalOperator.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -26,11 +26,21 @@
BEGIN_NAMESPACE_OSGEO_FDO_FILTER
/// \brief
-/// FdoLogicalOperator is an abstract base class. FdoBinaryLogicalOperator and
-/// FdoUnaryLogicalOperator derive from the FdoLogicalOperator class.
+/// The LogicalOperator is an abstract base class. BinaryLogicalOperator and
+/// UnaryLogicalOperator derive from the LogicalOperator class.
public __gc class LogicalOperator : public NAMESPACE_OSGEO_FDO_FILTER::Filter
{
public:
+ /// \brief
+ /// Constructs a LogicalOperator object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
LogicalOperator(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgNullCondition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgNullCondition.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgNullCondition.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -32,38 +32,38 @@
public __gc __interface IFilterProcessor;
/// \brief
-/// The FdoNullCondition class derives from FdoSearchCondition and can be used to test
+/// The NullCondition class derives from SearchCondition and can be used to test
/// if the value of a specified data property is null.
public __gc class NullCondition : public NAMESPACE_OSGEO_FDO_FILTER::SearchCondition
{
public:
/// \brief
- /// Constructs a default instance of an FdoNullCondition.
+ /// Constructs a default instance of an NullCondition.
///
/// \return
- /// Returns an FdoNullCondition
+ /// Returns an NullCondition
///
NullCondition();
/// \brief
- /// Constructs an instance of an FdoNullCondition using the specified arguments.
+ /// Constructs an instance of an NullCondition using the specified arguments.
///
/// \param propertyName
/// Input name
///
/// \return
- /// Returns an FdoNullCondition
+ /// Returns an NullCondition
///
NullCondition(System::String* propertyName);
/// \brief
- /// Constructs an instance of an FdoNullCondition using the specified arguments.
+ /// Constructs an instance of an NullCondition using the specified arguments.
///
/// \param propertyName
/// Input name
///
/// \return
- /// Returns an FdoNullCondition
+ /// Returns an NullCondition
///
NullCondition(NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* propertyName);
@@ -71,7 +71,7 @@
/// Gets the name of the data property.
///
/// \return
- /// Returns FdoIdentifier
+ /// Returns Identifier
///
__property NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* get_PropertyName();
@@ -87,7 +87,7 @@
__property System::Void set_PropertyName(NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* value);
/// \brief
- /// Overrides FdoFilter.Process to pass the FdoNullCondition to the
+ /// Overrides Filter.Process to pass NullCondition to the
/// appropriate filter processor operation.
///
/// \param processor
@@ -98,6 +98,16 @@
///
System::Void Process(NAMESPACE_OSGEO_FDO_FILTER::IFilterProcessor* processor);
+ /// \brief
+ /// Constructs a NullCondition object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
NullCondition(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgSearchCondition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgSearchCondition.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgSearchCondition.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -25,12 +25,22 @@
BEGIN_NAMESPACE_OSGEO_FDO_FILTER
/// \brief
-/// FdoSearchCondition is an abstract base class. FdoSpatialCondition,
-/// FdoComparisonCondition, FdoLikeCondition, FdoInCondition, and FdoNullCondition derive
-/// from the FdoSearchCondition class.
+/// The SearchCondition is an abstract base class. SpatialCondition,
+/// ComparisonCondition, LikeCondition, InCondition, and NullCondition derive
+/// from the SearchCondition class.
public __gc class SearchCondition : public NAMESPACE_OSGEO_FDO_FILTER::Filter
{
public:
+ /// \brief
+ /// Constructs a SearchCondition object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
SearchCondition(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgSpatialCondition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgSpatialCondition.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgSpatialCondition.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -32,7 +32,7 @@
public __gc __interface IFilterProcessor;
/// \brief
-/// The FdoSpatialCondition class derives from FdoGeometricCondition and can be used
+/// The SpatialCondition class derives from GeometricCondition and can be used
/// to test whether the value of a geometric property (referenced using the name
/// of the property) and another geometric value satisfy the spatial
/// relationship implied by the operation. Some feature providers may only
@@ -42,15 +42,15 @@
{
public:
/// \brief
- /// Constructs a default instance of an FdoSpatialCondition.
+ /// Constructs a default instance of an SpatialCondition.
///
/// \return
- /// Returns FdoSpatialCondition
+ /// Returns SpatialCondition
///
SpatialCondition();
/// \brief
- /// Constructs an instance of an FdoSpatialCondition using the specified arguments.
+ /// Constructs an instance of an SpatialCondition using the specified arguments.
///
/// \param propertyName
/// Input property name
@@ -60,12 +60,12 @@
/// Input geometry
///
/// \return
- /// Returns FdoSpatialCondition
+ /// Returns SpatialCondition
///
SpatialCondition(System::String* propertyName, NAMESPACE_OSGEO_FDO_FILTER::SpatialOperations operation, NAMESPACE_OSGEO_FDO_EXPRESSION::Expression* geometry);
/// \brief
- /// Constructs an instance of an FdoSpatialCondition using the specified arguments.
+ /// Constructs an instance of an SpatialCondition using the specified arguments.
///
/// \param propertyName
/// Input property name
@@ -75,7 +75,7 @@
/// Input geometry
///
/// \return
- /// Returns FdoSpatialCondition
+ /// Returns SpatialCondition
///
SpatialCondition(NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* propertyName, NAMESPACE_OSGEO_FDO_FILTER::SpatialOperations operation, NAMESPACE_OSGEO_FDO_EXPRESSION::Expression* geometry);
@@ -118,7 +118,7 @@
__property System::Void set_Geometry(NAMESPACE_OSGEO_FDO_EXPRESSION::Expression* value);
/// \brief
- /// Overrides FdoFilter.Process to pass the FdoSpatialCondition to the
+ /// Overrides Filter.Process to pass SpatialCondition to the
/// appropriate filter processor operation.
///
/// \param processor
@@ -129,6 +129,16 @@
///
System::Void Process(NAMESPACE_OSGEO_FDO_FILTER::IFilterProcessor* processor);
+ /// \brief
+ /// Constructs a SpatialCondition object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
SpatialCondition(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgSpatialOperations.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgSpatialOperations.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgSpatialOperations.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -21,48 +21,48 @@
BEGIN_NAMESPACE_OSGEO_FDO_FILTER
/// \brief
-/// The FdoSpatialOperations enumeration lists the spatial conditions available.
-/// <param name="FdoSpatialOperations_Contains">
+/// The SpatialOperations enumeration lists the spatial conditions available.
+/// <param name="SpatialOperations_Contains">
/// Test to see if the geometric property value spatially contains the
/// literal geometric value
/// </param>
-/// <param name="FdoSpatialOperations_Crosses">
+/// <param name="SpatialOperations_Crosses">
/// Test to see if the geometric property value spatially crosses the given
/// geometry
/// </param>
-/// <param name="FdoSpatialOperations_Disjoint">
+/// <param name="SpatialOperations_Disjoint">
/// Test to see if the geometric property value spatially is spatially
/// disjoint from the given geometry
/// </param>
-/// <param name="FdoSpatialOperations_Equals">
+/// <param name="SpatialOperations_Equals">
/// Test to see if the geometric property value is spatially equal to the
/// given geometry
/// </param>
-/// <param name="FdoSpatialOperations_Intersects">
+/// <param name="SpatialOperations_Intersects">
/// Test to see if the geometric property value spatially intersects the
/// given geometry
/// </param>
-/// <param name="FdoSpatialOperations_Overlaps">
+/// <param name="SpatialOperations_Overlaps">
/// Test to see if the geometric property value spatially overlaps the given
/// geometry
/// </param>
-/// <param name="FdoSpatialOperations_Touches">
+/// <param name="SpatialOperations_Touches">
/// Test to see if the geometric property value spatially touches the given
/// geometry
/// </param>
-/// <param name="FdoSpatialOperations_Within">
+/// <param name="SpatialOperations_Within">
/// Test to see if the geometric property value is spatially within the
/// given geometry
/// </param>
-/// <param name="FdoSpatialOperations_CoveredBy">
+/// <param name="SpatialOperations_CoveredBy">
/// Test to see if the geometric property value is covered by the interior
/// and boundary of the given geometry
/// </param>
-/// <param name="FdoSpatialOperations_Inside">
+/// <param name="SpatialOperations_Inside">
/// Test to see if the geometric property value is inside the interior
/// of the given geometry, not touching the boundary
/// </param>
-/// <param name="FdoSpatialOperations_EnvelopeIntersects">
+/// <param name="SpatialOperations_EnvelopeIntersects">
/// Test to see if the envelope of the referenced geometric property value intersects the
/// given geometry
/// </param>
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgUnaryLogicalOperations.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgUnaryLogicalOperations.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgUnaryLogicalOperations.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -21,9 +21,9 @@
BEGIN_NAMESPACE_OSGEO_FDO_FILTER
/// \brief
-/// The FdoUnaryLogicalOperations enumeration lists the unary logical operations
+/// The UnaryLogicalOperations enumeration lists the unary logical operations
/// available.
-/// <param name="FdoUnaryLogicalOperations_Not">
+/// <param name="UnaryLogicalOperations_Not">
/// Perform a logical Not of the filter
/// </param>
[System::FlagsAttribute]
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgUnaryLogicalOperator.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgUnaryLogicalOperator.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgUnaryLogicalOperator.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -28,21 +28,21 @@
public __gc __interface IFilterProcessor;
/// \brief
-/// The FdoUnaryLogicalOperator class derives from FdoLogicalOperator and allows a
+/// The UnaryLogicalOperator class derives from LogicalOperator and allows a
/// logical "Not" to be performed against a filter.
public __gc class UnaryLogicalOperator : public NAMESPACE_OSGEO_FDO_FILTER::LogicalOperator
{
public:
/// \brief
- /// Constructs a default instance of an FdoUnaryLogicalOperator.
+ /// Constructs a default instance of an UnaryLogicalOperator.
///
/// \return
- /// Returns FdoUnaryLogicalOperator
+ /// Returns UnaryLogicalOperator
///
UnaryLogicalOperator();
/// \brief
- /// Constructs an instance of an FdoUnaryLogicalOperator using the specified arguments.
+ /// Constructs an instance of an UnaryLogicalOperator using the specified arguments.
///
/// \param operand
/// Input operand
@@ -50,7 +50,7 @@
/// Input operation
///
/// \return
- /// Returns FdoUnaryLogicalOperator
+ /// Returns UnaryLogicalOperator
///
UnaryLogicalOperator(NAMESPACE_OSGEO_FDO_FILTER::Filter* operand, NAMESPACE_OSGEO_FDO_FILTER::UnaryLogicalOperations operation);
@@ -74,7 +74,7 @@
__property System::Void set_Operation(NAMESPACE_OSGEO_FDO_FILTER::UnaryLogicalOperations value);
/// \brief
- /// Gets the FdoFilter operand to apply the operator to.
+ /// Gets Filter operand to apply the operator to.
///
/// \return
/// Returns filter
@@ -82,7 +82,7 @@
__property NAMESPACE_OSGEO_FDO_FILTER::Filter* get_Operand();
/// \brief
- /// Sets the FdoFilter operand to apply the operator to.
+ /// Sets Filter operand to apply the operator to.
///
/// \param value
/// Input filter
@@ -93,7 +93,7 @@
__property System::Void set_Operand(NAMESPACE_OSGEO_FDO_FILTER::Filter* value);
/// \brief
- /// Overrides FdoFilter.Process to pass the FdoUnaryLogicalOperator to the
+ /// Overrides Filter.Process to pass UnaryLogicalOperator to the
/// appropriate filter processor operation.
///
/// \param processor
@@ -104,6 +104,16 @@
///
System::Void Process(NAMESPACE_OSGEO_FDO_FILTER::IFilterProcessor* processor);
+ /// \brief
+ /// Constructs a UnaryLogicalOperator object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
UnaryLogicalOperator(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgValueExpressionCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgValueExpressionCollection.h 2007-02-02 00:51:18 UTC (rev 706)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Filter/mgValueExpressionCollection.h 2007-02-02 00:58:17 UTC (rev 707)
@@ -29,13 +29,32 @@
BEGIN_NAMESPACE_OSGEO_FDO_FILTER
/// \brief
-/// FdoArgumentDefinitionCollection is a collection of name-value pairs.
+/// The ValueExpressionCollection is a collection of ValueExpression objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class ValueExpressionCollection : 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
{
@@ -44,15 +63,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(ValueExpressionCollection* elements) : m_pCol(elements), m_nIdx(-1)
{
}
- __property System::Object* get_Current();
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
+ __property System::Object *get_Current();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first object in the collection.
+ /// At this position, calling the Current property throws an exception.
+ /// Therefore, you must call the MoveNext method to advance the enumerator
+ /// to the first element of the collection before reading the value of Current.
+ /// If MoveNext passes the end of the collection, the enumerator is positioned
+ /// after the last element in the collection and MoveNext returns false.
+ /// When the enumerator is at this position, subsequent calls to MoveNext also return false.
+ /// If the last call to MoveNext returned false, calling Current throws an exception.
+ /// To set Current to the first element of the collection again, you can call Reset
+ /// followed by MoveNext.
+ ///
+ /// \return
+ /// Retuns true if the Enumerator is able to move to a valid element
+ /// otherwise false.
+ ///
System::Boolean MoveNext();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// The Reset method brings the enumerator back to this position.
+ ///
System::Void Reset();
};
@@ -60,49 +111,63 @@
inline FdoValueExpressionCollection* GetImpObj();
private:
- /// System::Collections::ICollection interfaces
- System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
+ // System::Collections::ICollection interface properties
+ __property System::Object* System::Collections::ICollection::get_SyncRoot();
+ __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
- __property System::Object* System::Collections::ICollection::get_SyncRoot();
+ // System::Collections::ICollection interface methods
+ System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
- __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
+ // System::Collections::IList interface properties
+ __property System::Boolean System::Collections::IList::get_IsFixedSize();
+ __property System::Boolean System::Collections::IList::get_IsReadOnly();
+ __property Object* System::Collections::IList::get_Item(System::Int32 index);
+ __property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
- // System::Collections::IList interfaces
- __property System::Boolean System::Collections::IList::get_IsFixedSize();
+ // System::Collections::IList interface methods
+ System::Int32 System::Collections::IList::Add(Object* value);
+ System::Boolean System::Collections::IList::Contains(Object* value);
+ System::Int32 System::Collections::IList::IndexOf(Object* value);
+ System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
+ System::Void System::Collections::IList::Remove(Object* value);
+/// \endcond
- __property System::Boolean System::Collections::IList::get_IsReadOnly();
-
- System::Int32 System::Collections::IList::Add(Object* value);
-
- System::Boolean System::Collections::IList::Contains(Object* value);
-
- System::Int32 System::Collections::IList::IndexOf(Object* value);
-
- System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
-
- System::Void System::Collections::IList::Remove(Object* value);
-
- __property Object* System::Collections::IList::get_Item(System::Int32 index);
-
- __property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
-
public:
+ /// \brief
+ /// The defaut constructor for the object
+ ///
ValueExpressionCollection();
+ /// \brief
+ /// Constructs a ValueExpressionCollection object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
ValueExpressionCollection(System::IntPtr unmanaged, System::Boolean autoDelete);
/// \brief
- /// Gets the count of items in collection.
+ /// Gets the count of items in collection.
///
+ /// \return
+ /// Returns the number of items in the collection.
+ ///
__property System::Int32 get_Count(System::Void);
/// \brief
- /// Gets an enumerator that can iterate through a collection.
+ /// Gets an enumerator that can iterate through a collection.
///
+ /// \return
+ /// Returns an enumerator on the dictionary.
+ ///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Removes the index-th ArgumentDefinition from this collection.
+ /// Removes the index-th ValueExpression from this collection.
///
/// \param index
/// Input index of the element to remove.
@@ -110,63 +175,63 @@
System::Void RemoveAt(System::Int32 index);
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
/// \brief
- /// Adds a ArgumentDefinition object into the collection.
+ /// Adds a ValueExpression object into the collection.
///
/// \param value
- /// Input the ArgumentDefinition object to add.
+ /// Input the ValueExpression object to add.
///
/// \return
- /// Returns the position into which the new element was inserted.
+ /// Returns the position into which the new element was inserted.
///
System::Int32 Add(NAMESPACE_OSGEO_FDO_EXPRESSION::ValueExpression* value);
/// \brief
- /// Determines the index of a specific ArgumentDefinition object.
+ /// Determines the index of a specific ValueExpression object.
///
/// \param value
- /// Input the ArgumentDefinition object to locate in the collection.
+ /// Input the ValueExpression object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_FDO_EXPRESSION::ValueExpression* value);
/// \brief
- /// Inserts a ArgumentDefinition object into the collection at the specified position.
+ /// Inserts a ValueExpression object into the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
/// \param value
- /// Input the ArgumentDefinition object to insert.
+ /// Input the ValueExpression object to insert.
///
System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_FDO_EXPRESSION::ValueExpression* value);
/// \brief
- /// Removes the first occurrence of a specific ArgumentDefinition object.
+ /// Removes the first occurrence of a specific ValueExpression object.
///
/// \param value
- /// Input the ArgumentDefinition object to remove from the collection.
+ /// Input the ValueExpression object to remove from the collection.
///
System::Void Remove(NAMESPACE_OSGEO_FDO_EXPRESSION::ValueExpression* value);
/// \brief
- /// Determines whether the collection contains a specific ArgumentDefinition object.
+ /// Determines whether the collection contains a specific ValueExpression object.
///
/// \param value
- /// Input The ArgumentDefinition object to search in the collection.
+ /// Input The ValueExpression object to search in the collection.
///
/// \return
- /// Returns true if the value is found in the collection; otherwise, false.
+ /// Returns true if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(NAMESPACE_OSGEO_FDO_EXPRESSION::ValueExpression* value);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// Copies the elements of the collection to an array.
///
/// \param array
/// Output the one-dimensional Array that is the destination of the elements copied from this collection.
@@ -175,23 +240,55 @@
///
System::Void CopyTo(NAMESPACE_OSGEO_FDO_EXPRESSION::ValueExpression* array[],System::Int32 size);
-
/// \brief
- /// Gets or sets a ArgumentDefinition in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the ArgumentDefinition to retrieve or set (System::Int32).
+ /// The index of the item in the collection. The index is 0 based.
///
+ /// \return
+ /// Returns an instance of a the collected item.
+ /// Throws an instance of Exception if the index is out of range or an error occurs.
+ ///
__property NAMESPACE_OSGEO_FDO_EXPRESSION::ValueExpression* get_RealTypeItem(System::Int32 index);
+ /// \brief
+ /// Sets the value of the item at the specified index
+ ///
+ /// \param index
+ /// Input index of the item to set.
+ ///
+ /// \param value
+ /// Input the value of the item
+ ///
__property System::Void set_RealTypeItem(System::Int32 index, NAMESPACE_OSGEO_FDO_EXPRESSION::ValueExpression* value);
+ /// \brief
+ /// Gets an item in the collection.
+ ///
+ /// \param index
+ /// Input index of the item to retrieve.
+ ///
+ /// \return
+ /// Returns the item at the specified index
+ ///
__property NAMESPACE_OSGEO_FDO_EXPRESSION::ValueExpression* get_Item(System::Int32 index);
+ /// \brief
+ /// Sets the value of the item at the specified index
+ ///
+ /// \param index
+ /// Input index of the item to set.
+ ///
+ /// \param value
+ /// Input the value of the item
+ ///
__property System::Void set_Item(System::Int32 index, NAMESPACE_OSGEO_FDO_EXPRESSION::ValueExpression* value);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_EXPRESSION
More information about the fdo-commits
mailing list