Ellipsoid Class Reference

Definition of the globe as elliptical distortion of a sphere. More...

#include <BaseGeoCoord.h>

Public Member Functions
bool	IsValid () const
	Returns whether the Ellipsoid is valid or not. More...
int	GetError () const
	Gets the error code associated with constructor failure if IsValid is false. More...
WCharCP	GetErrorMessage (WStringR errorMsg) const
	Gets the error message associated with constructor failure if IsValid is false. More...
WCharCP	GetName () const
	Gets the name of the Ellipsoid. More...
StatusInt	SetName (WCharCP value)
	Sets the key name of the Ellipsoid. More...
WCharCP	GetDescription () const
	Gets the description of the Ellipsoid. More...
WCharCP	GetSource (WStringR source) const
	Sets the source of the Ellipsoid. More...
double	GetPolarRadius () const
	Gets the polar radius of the Ellipsoid. More...
double	GetEquatorialRadius () const
	Gets the equatorial radius of the Ellipsoid. More...
double	GetEccentricity () const
	Gets the eccentricity value for the Ellipsoid. More...
int	GetEPSGCode () const
	Gets the EPSG code for this Ellipsoid, if known. More...
void	Destroy () const
	Free this Group. More...

Static Public Member Functions
static EllipsoidCP	CreateEllipsoid (WCharCP keyName)
	Initializes a new instance of the Ellipsoid class. More...
static EllipsoidEnumeratorP	CreateEnumerator ()
	Factory method to create an EllipsoidEnumerator. More...

Detailed Description

Definition of the globe as elliptical distortion of a sphere.

Member Function Documentation

static EllipsoidCP CreateEllipsoid ( WCharCP  keyName )

static

Initializes a new instance of the Ellipsoid class.

Returns

Initialized Ellipsoid.

Remarks

If keyName is in the Ellipsoid library and valid, the return Ellipsoid's IsValid() returns true. Otherwise, the GetError() or GetErrorMessage() methods return the error.

static EllipsoidEnumeratorP CreateEnumerator ( )

static

Factory method to create an EllipsoidEnumerator.

Returns

An initialized EllipsoidEnumerator

void Destroy

(

)

const

Free this Group.

WCharCP GetDescription

(

)

const

Gets the description of the Ellipsoid.

Returns

The description of the Ellipsoid.

double GetEccentricity

(

)

const

Gets the eccentricity value for the Ellipsoid.

Returns

The eccentricity value for the Ellipsoid.

int GetEPSGCode

(

)

const

Gets the EPSG code for this Ellipsoid, if known.

Returns

The EPSG code.

double GetEquatorialRadius

(

)

const

Gets the equatorial radius of the Ellipsoid.

Returns

The equatorial radius of the Ellipsoid.

int GetError

(

)

const

Gets the error code associated with constructor failure if IsValid is false.

Returns

The CSMap error code.

See also

GetErrorMessage

WCharCP GetErrorMessage

(

WStringR

errorMsg

)

const

Gets the error message associated with constructor failure if IsValid is false.

Returns

The CSMap error message.

See also

GetError

WCharCP GetName

(

)

const

Gets the name of the Ellipsoid.

Returns

The name of the Ellipsoid.

double GetPolarRadius

(

)

const

Gets the polar radius of the Ellipsoid.

Returns

The polar radius of the Ellipsoid.

WCharCP GetSource

(

WStringR

source

)

const

Sets the source of the Ellipsoid.

Returns

The source of the Ellipsoid.

bool IsValid

(

)

const

Returns whether the Ellipsoid is valid or not.

Returns

True if the Ellipsoid is valid, False otherwise.

See also

GetError

Remarks

If the Ellipsoid does not correspond to a Ellipsoid in the Ellipsoid library, IsValid is false, and GetError and GetErrorMessage can be used to obtain more details.

StatusInt SetName

(

WCharCP

value

)

Sets the key name of the Ellipsoid.

Returns

BSISUCCESS or an error code.

---

The documentation for this class was generated from the following file:

• BaseGeoCoord.h