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

FdoILinearRing Class Reference

#include <ILinearRing.h>

Inherits FdoIRingAbstract.

Inheritance diagram for FdoILinearRing:

[legend]
List of all members.

Detailed Description

The FdoILinearRing class is a linear ring helper type. The shape of FdoILinearRing is the set of positions defined by the contained collection, plus linear interpolation between consecutive points.

Definition at line 36 of file ILinearRing.h.


Public Member Functions

virtual FDO_GEOM_API FdoInt32 GetCount () const =0
 Gets the number of positions in this object.
virtual FDO_GEOM_API FdoIDirectPositionGetItem (FdoInt32 index) const =0
 Gets the position at the specified (zero-based) index.
virtual FDO_GEOM_API void GetItemByMembers (FdoInt32 index, double *x, double *y, double *z, double *m, FdoInt32 *dimensionality) const =0
 Gets the position at the specified (zero-based) index, by values of its member data. This is in aid of higher performance for any implementation that does not internally use FdoIDirectPosition objects for storage, or for an application seeking to avoid overhead of accessor methods.
virtual FDO_GEOM_API const
double * 
GetOrdinates ()=0
 Gets the ordinates as an array.
virtual FDO_GEOM_API FdoDirectPositionCollectionGetPositions ()=0
 Gets a collection of all of the positions in this object.

Protected Member Functions

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

Constructor & Destructor Documentation

FDO_GEOM_API FdoILinearRing::FdoILinearRing  )  [inline, protected]
 

Constructs a default instance.

Returns:
Returns nothing

Definition at line 119 of file ILinearRing.h.

References FDO_GEOM_API.

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

Default destructor.

Returns:
Returns nothing

Definition at line 127 of file ILinearRing.h.

References FDO_GEOM_API.


Member Function Documentation

virtual FDO_GEOM_API FdoInt32 FdoILinearRing::GetCount  )  const [pure virtual]
 

Gets the number of positions in this object.

Returns:
Returns the number of positions

virtual FDO_GEOM_API FdoIDirectPosition* FdoILinearRing::GetItem FdoInt32  index  )  const [pure virtual]
 

Gets the position at the specified (zero-based) index.

Parameters:
index Input Zero-based index in the object's list of positions.
Returns:
Returns the position

virtual FDO_GEOM_API void FdoILinearRing::GetItemByMembers FdoInt32  index,
double *  x,
double *  y,
double *  z,
double *  m,
FdoInt32 dimensionality
const [pure virtual]
 

Gets the position at the specified (zero-based) index, by values of its member data. This is in aid of higher performance for any implementation that does not internally use FdoIDirectPosition objects for storage, or for an application seeking to avoid overhead of accessor methods.

Parameters:
index Input Zero-based index in the object's list of positions.
x Output X ordinate value.
y Output Y ordinate value.
z Output Z ordinate value.
m Output M ordinate value.
dimensionality Output Dimensionality of ordinates in this position.
Returns:
Returns nothing

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

Gets the ordinates as an array.

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

virtual FDO_GEOM_API FdoDirectPositionCollection* FdoILinearRing::GetPositions  )  [pure virtual]
 

Gets a collection of all of the positions in this object.

Returns:
Returns the positions

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