FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoSpatialCondition Class Reference

#include <SpatialCondition.h>

Inherits FdoGeometricCondition.

Inheritance diagram for FdoSpatialCondition:

[legend]
List of all members.

Detailed Description

The FdoSpatialCondition class derives from FdoGeometricCondition 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 support literal geometric values; if so, the provider's capabilities will indicate this limitation.

Definition at line 41 of file SpatialCondition.h.


Public Member Functions

FDO_API FdoExpressionGetGeometry ()
 Gets the literal geometric value.
FDO_API FdoSpatialOperations GetOperation ()
 Gets the spatial operation to use.
FDO_API void Process (FdoIFilterProcessor *p)
 Overrides FdoFilter.Process to pass the FdoSpatialCondition to the appropriate filter processor operation.
FDO_API void SetGeometry (FdoExpression *value)
 Sets the literal geometric value.
FDO_API void SetOperation (FdoSpatialOperations value)
 Sets the spatial operation to use.
FdoStringToStringInternal (FdoIdentifierCollection *pIdCol)
 DOXYGEN-IGNORE This is an internal method. It returns the well defined text representation of the filter.

Static Public Member Functions

FDO_API FdoSpatialConditionCreate (FdoIdentifier *propertyName, FdoSpatialOperations operation, FdoExpression *geometry)
 Constructs an instance of an FdoSpatialCondition using the specified arguments.
FDO_API FdoSpatialConditionCreate (FdoString *propertyName, FdoSpatialOperations operation, FdoExpression *geometry)
 Constructs an instance of an FdoSpatialCondition using the specified arguments.
FDO_API FdoSpatialConditionCreate ()
 Constructs a default instance of an FdoSpatialCondition.

Protected Member Functions

virtual void Dispose ()
 Dispose this object.
 FdoSpatialCondition (FdoIdentifier *propertyName, FdoSpatialOperations operation, FdoExpression *geometry)
 FdoSpatialCondition (FdoString *propertyName, FdoSpatialOperations operation, FdoExpression *geometry)
 FdoSpatialCondition ()
 Constructs a default instance of an FdoSpatialCondition.
virtual ~FdoSpatialCondition ()

Constructor & Destructor Documentation

FdoSpatialCondition::FdoSpatialCondition  )  [protected]
 

Constructs a default instance of an FdoSpatialCondition.

FdoSpatialCondition::FdoSpatialCondition FdoString propertyName,
FdoSpatialOperations  operation,
FdoExpression geometry
[protected]
 

Constructs an instance of an FdoSpatialCondition using the specified arguments.

FdoSpatialCondition::FdoSpatialCondition FdoIdentifier propertyName,
FdoSpatialOperations  operation,
FdoExpression geometry
[protected]
 

Constructs an instance of an FdoSpatialCondition using the specified arguments.

virtual FdoSpatialCondition::~FdoSpatialCondition  )  [protected, virtual]
 


Member Function Documentation

FDO_API FdoSpatialCondition* FdoSpatialCondition::Create FdoIdentifier propertyName,
FdoSpatialOperations  operation,
FdoExpression geometry
[static]
 

Constructs an instance of an FdoSpatialCondition using the specified arguments.

Parameters:
propertyName Input property name
operation Input spatial operation
geometry Input geometry
Returns:
Returns FdoSpatialCondition

FDO_API FdoSpatialCondition* FdoSpatialCondition::Create FdoString propertyName,
FdoSpatialOperations  operation,
FdoExpression geometry
[static]
 

Constructs an instance of an FdoSpatialCondition using the specified arguments.

Parameters:
propertyName Input property name
operation Input spatial operation
geometry Input geometry
Returns:
Returns FdoSpatialCondition

FDO_API FdoSpatialCondition* FdoSpatialCondition::Create  )  [static]
 

Constructs a default instance of an FdoSpatialCondition.

Returns:
Returns FdoSpatialCondition

virtual void FdoSpatialCondition::Dispose  )  [protected, virtual]
 

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

FDO_API FdoExpression* FdoSpatialCondition::GetGeometry  ) 
 

Gets the literal geometric value.

Returns:
Returns the literal geometric valueg

FDO_API FdoSpatialOperations FdoSpatialCondition::GetOperation  ) 
 

Gets the spatial operation to use.

Returns:
Returns the spatial operation to use

FDO_API void FdoSpatialCondition::Process FdoIFilterProcessor p  )  [virtual]
 

Overrides FdoFilter.Process to pass the FdoSpatialCondition to the appropriate filter processor operation.

Parameters:
p Input filter processor
Returns:
Returns nothing

Implements FdoFilter.

FDO_API void FdoSpatialCondition::SetGeometry FdoExpression value  ) 
 

Sets the literal geometric value.

Parameters:
value Input the literal geometric value
Returns:
Returns nothing

FDO_API void FdoSpatialCondition::SetOperation FdoSpatialOperations  value  ) 
 

Sets the spatial operation to use.

Parameters:
value Input the spatial operation to use
Returns:
Returns nothing

FdoString* FdoSpatialCondition::ToStringInternal FdoIdentifierCollection pIdCol  )  [virtual]
 

DOXYGEN-IGNORE This is an internal method. It returns the well defined text representation of the filter.

Parameters:
pIdCol A identifier collection that contains all the computed identifier used by the filter
Returns:
Returns the well defined text string

Implements FdoFilter.


The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.