FDO API Reference

Feature Data Objects

FdoDistanceCondition Class Reference

#include <DistanceCondition.h>

Inherits FdoGeometricCondition.

Inheritance diagram for FdoDistanceCondition:

[legend]List of all members.

---

Detailed Description

The FdoDistanceCondition class derives from FdoGeometricCondition 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 will indicate this limitation.

Definition at line 41 of file DistanceCondition.h.

Public Member Functions
FDO_API double	GetDistance ()
	Gets the distance value.
FDO_API FdoExpression *	GetGeometry ()
	Gets the literal geometric value.
FDO_API FdoDistanceOperations	GetOperation ()
	Gets the distance operation to use.
FDO_API void	Process (FdoIFilterProcessor *p)
	Overrides FdoFilter.Process to pass the FdoDistanceCondition to the appropriate filter processor operation.
FDO_API void	SetDistance (double value)
	Sets the distance value.
FDO_API void	SetGeometry (FdoExpression *value)
	Sets the literal geometric value.
FDO_API void	SetOperation (FdoDistanceOperations value)
	Sets the distance operation to use.
FdoString *	ToStringInternal (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 FdoDistanceCondition *	Create (FdoIdentifier *propertyName, FdoDistanceOperations operation, FdoExpression *geometry, double distance)
	Constructs an instance of an FdoDistanceCondition using the specified arguments.
FDO_API FdoDistanceCondition *	Create (FdoString *propertyName, FdoDistanceOperations operation, FdoExpression *geometry, double distance)
	Constructs an instance of an FdoDistanceCondition using the specified arguments.
FDO_API FdoDistanceCondition *	Create ()
	Constructs a default instance of an FdoDistanceCondition.
Protected Member Functions
virtual void	Dispose ()
	Dispose this object.
	FdoDistanceCondition (FdoIdentifier *propertyName, FdoDistanceOperations operation, FdoExpression *geometry, double distance)
	FdoDistanceCondition (FdoString *propertyName, FdoDistanceOperations operation, FdoExpression *geometry, double distance)
	FdoDistanceCondition ()
	Constructs a default instance of an FdoDistanceCondition.
virtual	~FdoDistanceCondition ()

---

Constructor & Destructor Documentation

FdoDistanceCondition::FdoDistanceCondition (   )  [protected]

Constructs a default instance of an FdoDistanceCondition.

FdoDistanceCondition::FdoDistanceCondition (  FdoString *  propertyName, FdoDistanceOperations  operation, FdoExpression *  geometry, double  distance )  [protected]

Constructs an instance of an FdoDistanceCondition using the specified arguments.

FdoDistanceCondition::FdoDistanceCondition (  FdoIdentifier *  propertyName, FdoDistanceOperations  operation, FdoExpression *  geometry, double  distance )  [protected]

Constructs an instance of an FdoDistanceCondition using the specified arguments.

virtual FdoDistanceCondition::~FdoDistanceCondition (   )  [protected, virtual]

---

Member Function Documentation

FDO_API FdoDistanceCondition* FdoDistanceCondition::Create (  FdoIdentifier *  propertyName, FdoDistanceOperations  operation, FdoExpression *  geometry, double  distance )  [static]

Constructs an instance of an FdoDistanceCondition using the specified arguments. Parameters: propertyName  Input property name operation  Input operation geometry  Input geometry distance  Input distance Returns: Returns FdoDistanceCondition

FDO_API FdoDistanceCondition* FdoDistanceCondition::Create (  FdoString *  propertyName, FdoDistanceOperations  operation, FdoExpression *  geometry, double  distance )  [static]

Constructs an instance of an FdoDistanceCondition using the specified arguments. Parameters: propertyName  Input property name operation  Input operation geometry  Input geometry distance  Input distance Returns: Returns FdoDistanceCondition

FDO_API FdoDistanceCondition* FdoDistanceCondition::Create (   )  [static]

Constructs a default instance of an FdoDistanceCondition. Returns: Returns FdoDistanceCondition

virtual void FdoDistanceCondition::Dispose (   )  [protected, virtual]

Dispose this object. Returns: Returns nothing Implements FdoIDisposable.

FDO_API double FdoDistanceCondition::GetDistance (   )

Gets the distance value. Returns: Returns the distance value

FDO_API FdoExpression* FdoDistanceCondition::GetGeometry (   )

Gets the literal geometric value. Returns: Returns the literal geometric value

FDO_API FdoDistanceOperations FdoDistanceCondition::GetOperation (   )

Gets the distance operation to use. Returns: Returns the distance operation

FDO_API void FdoDistanceCondition::Process (  FdoIFilterProcessor *  p  )  [virtual]

Overrides FdoFilter.Process to pass the FdoDistanceCondition to the appropriate filter processor operation. Parameters: p  Input filter processor Returns: Returns nothing Implements FdoFilter.

FDO_API void FdoDistanceCondition::SetDistance (  double  value  )

Sets the distance value. Parameters: value  Input the distance value Returns: Returns nothing

FDO_API void FdoDistanceCondition::SetGeometry (  FdoExpression *  value  )

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

FDO_API void FdoDistanceCondition::SetOperation (  FdoDistanceOperations  value  )

Sets the distance operation to use. Parameters: value  Input the distance operation Returns: Returns nothing

FdoString* FdoDistanceCondition::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:

• DistanceCondition.h

---

Comments or suggestions? Send us feedback.