get_Dimensions Method

WRAPPER_API short get_Dimensions() const

 

Description

The get_Dimensions method returns the number of coordinate values that define the location of this point.  The value returned by this method will be 1, 2 or 3.

For a CartesianPoint, a Dimensions value of 2 indicates that only the X and Y properties are used to express the position of the point, whereas a Dimensions value of 3 indicates that X, Y, and Z are used.

For a GeodeticPoint, a Dimensions value of 2 indicates that only the Latitude and Longitude properties are used to express the position of the point, whereas a Dimensions value of 3 indicates that Latitude, Longitude, and Height are used.

For a ProjectedPoint, a Dimensions value of 2 indicates that only the North and East properties are used to express the position of the point, whereas a Dimensions value of 3 indicates that North, East, and Height are used.

A StringPoint and a VerticalPoint will always have Dimensions set to 1.