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

FdoIDirectPosition Class Reference

#include <IDirectPosition.h>

Inherits FdoIDisposable.

Inherited by FdoDirectPositionImpl.

Inheritance diagram for FdoIDirectPosition:

[legend]
List of all members.

Detailed Description

The FdoIDirectPosition class is a direct position object. FdoIDirectPosition is a simple coordinate position in any allowed dimension. The actual object may have several implementations, depending on the dimension and other factors. This is a lightweight helper type for Geometries in the Geometry package.

Note:
It does not derive from IGeometry.

Definition at line 39 of file IDirectPosition.h.


Public Member Functions

virtual FDO_GEOM_API FdoInt32 GetDimensionality () const =0
 Gets the dimensionality of ordinates in this position.
virtual FDO_GEOM_API double GetM () const =0
 Gets the M ordinate.
virtual FDO_GEOM_API const
double * 
GetOrdinates ()=0
 Gets the ordinates as an array.
virtual FDO_GEOM_API double GetX () const =0
 Gets the X ordinate.
virtual FDO_GEOM_API double GetY () const =0
 Gets the Y ordinate.
virtual FDO_GEOM_API double GetZ () const =0
 Gets the Z ordinate.

Protected Member Functions

FDO_GEOM_API FdoIDirectPosition ()
 Constructs a default instance.
virtual FDO_GEOM_API ~FdoIDirectPosition ()
 Default destructor.

Constructor & Destructor Documentation

FDO_GEOM_API FdoIDirectPosition::FdoIDirectPosition  )  [inline, protected]
 

Constructs a default instance.

Returns:
Returns nothing

Definition at line 109 of file IDirectPosition.h.

References FDO_GEOM_API.

virtual FDO_GEOM_API FdoIDirectPosition::~FdoIDirectPosition  )  [inline, protected, virtual]
 

Default destructor.

Returns:
Returns nothing

Definition at line 117 of file IDirectPosition.h.

References FDO_GEOM_API.


Member Function Documentation

virtual FDO_GEOM_API FdoInt32 FdoIDirectPosition::GetDimensionality  )  const [pure virtual]
 

Gets the dimensionality of ordinates in this position.

Remarks:
Values are from the FdoDimensionality enumeration. A return type of "FdoInt32" is used instead of the enumeration, catering to typical use with bit masking.
Returns:
Returns the ordinate dimensionality

Implemented in FdoDirectPositionImpl.

virtual FDO_GEOM_API double FdoIDirectPosition::GetM  )  const [pure virtual]
 

Gets the M ordinate.

Returns:
Returns the M ordinate; default is numeric_limits<double>::quiet_NaN()

Implemented in FdoDirectPositionImpl.

virtual FDO_GEOM_API const double* FdoIDirectPosition::GetOrdinates  )  [pure virtual]
 

Gets the ordinates as an array.

Remarks:
The caller must not free the returned array. The ordinates are in the order XYZM, with only those present according to the dimensionality.
Returns:
Returns the ordinates

Implemented in FdoDirectPositionImpl.

virtual FDO_GEOM_API double FdoIDirectPosition::GetX  )  const [pure virtual]
 

Gets the X ordinate.

Returns:
Returns the X ordinate; default is numeric_limits<double>::quiet_NaN()

Implemented in FdoDirectPositionImpl.

virtual FDO_GEOM_API double FdoIDirectPosition::GetY  )  const [pure virtual]
 

Gets the Y ordinate.

Returns:
Returns the Y ordinate; default is numeric_limits<double>::quiet_NaN()

Implemented in FdoDirectPositionImpl.

virtual FDO_GEOM_API double FdoIDirectPosition::GetZ  )  const [pure virtual]
 

Gets the Z ordinate.

Returns:
Returns the Z ordinate; default is numeric_limits<double>::quiet_NaN()

Implemented in FdoDirectPositionImpl.


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