get_InUnits Method

 

WRAPPER_API virtual bool get_InUnits(double &dZ) const

WRAPPER_API virtual bool get_InUnits(double &dX, double &dY) const

WRAPPER_API virtual bool get_InUnits(double &dX, double &dY, double &dZ) const

 

Description

The get_InUnits method gets the values of the CoordPoint's coordinates in the units used by the CoordPoint.  The values are returned in the form of the double arguments passed by reference.  It returns a boolean value indicating the success of the operation.  

There are three forms of this method, one for a one-dimensional CoordPoint that takes one argument,  one for a two-dimensional CoordPoint that takes two arguments and one for a three-dimensional CoordPoint that takes three arguments.  

If this is a CartesianPoint, then the arguments x, y, and z correspond to the X, Y, and Z properties, respectively.

If this is a GeodeticPoint, then the arguments x, y, and z correspond to the Longitude, Latitude, and Height properties, respectively.

If this is a ProjectedPoint, then the arguments x, y, and z correspond to the East, North, and Height properties, respectively.

If this is a StringPoint, this function will throw an exception

If this is a VerticalPoint, then the argument z corresponds to Height.