Rogue Wave Views
Maps Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions | Static Public Member Functions
IlvHorizontalShiftDatum Class Reference

This class describes a horizontal datum. More...

#include <ilviews/maps/projection/hshiftdatum.h>

Inheritance diagram for IlvHorizontalShiftDatum:
IlvHorizontalDatum

Public Member Functions

 IlvHorizontalShiftDatum (const char *name, const char *regionOfUse, const IlvEllipsoid &ellipsoid, IlDouble dx, IlDouble dy, IlDouble dz)
 Initializes an instance of the IlvHorizontalShiftDatum class. More...
 
 IlvHorizontalShiftDatum (const IlvHorizontalShiftDatum &source)
 Initializes a new instance of the IlvHorizontalShiftDatum by copying specified horizontal shift datum. More...
 
virtual IlvHorizontalDatumcopy () const
 Returns a new copy of this IlvHorizontalShiftDatum.
 
IlBoolean equivalent (const IlvHorizontalDatum *datum) const
 Returns IlTrue if the specified datum is equivalent to this. More...
 
IlDouble getDX () const
 Returns the shift on the X axis, in meters.
 
IlDouble getDY () const
 Returns the shift on the Y axis, in meters.
 
IlDouble getDZ () const
 Returns the shift on the Z axis, in meters.
 
const char * getName () const
 Returns the name of the ellipsoid.
 
const char * getRegionOfUse () const
 Returns the name of the region where the datum is used in.
 
- Public Member Functions inherited from IlvHorizontalDatum
const IlvEllipsoidgetEllipsoid () const
 Returns the ellipsoid for this datum. More...
 
IlvMapsError getInitStatus () const
 Returns the initialization status of this datum. More...
 
void save (IlvOutputFile &file) const
 Saves an instance of a subclass of IlvHorizontalDatum to the specified output file. More...
 
virtual void write (IlvOutputFile &file) const
 Write the object to an IlvOutputFile. More...
 

Static Public Member Functions

static const IlvHorizontalShiftDatumWGS84 ()
 The WGS84 datum.
 
- Static Public Member Functions inherited from IlvHorizontalDatum
static const IlvHorizontalDatumConverterFactoryGetConverterFactory ()
 Returns a factory than can create converters to convert coordinates from one datum to another. More...
 
static IlvHorizontalDatumLoad (IlvInputFile &inputFile)
 This static method loads a datum from the specified file. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IlvHorizontalDatum
 IlvHorizontalDatum (const IlvEllipsoid &ellipsoid)
 Initializes a new instance of IlvHorizontalDatum. More...
 
 IlvHorizontalDatum (const IlvHorizontalDatum &source)
 Initializes a new instance of IlvHorizontalDatum, copying the specified datum. More...
 
 IlvHorizontalDatum (IlvInputFile &file)
 Reads an IlvHorizontalDatum from specified input file. More...
 
void setInitStatus (IlvMapsError status)
 Sets the initialization status of this datum. More...
 

Detailed Description

This class describes a horizontal datum.

Library: ilvmaps

A horizontal datum is defined by a translation of the ellipsoid. Usually, the translation is performed so that the translated ellipsoid is tangent to the geoid surface in the region of interest. An IlvHorizontalShiftDatum object is based on the shift parameters relative to the WGS84 datum used by the Molodensky formula.

See also
IlvMolodenskyConverter.

Constructor & Destructor Documentation

IlvHorizontalShiftDatum::IlvHorizontalShiftDatum ( const char *  name,
const char *  regionOfUse,
const IlvEllipsoid ellipsoid,
IlDouble  dx,
IlDouble  dy,
IlDouble  dz 
)

Initializes an instance of the IlvHorizontalShiftDatum class.

Parameters
nameName of the datum. This string is duplicated by the constructor.
regionOfUseString describing the region this datum is used. This string is duplicated by the constructor.
ellipsoidThe ellipsoid for this datum.
dxShift on the x axis, in meters.
dyShift on the y axis, in meters.
dzShift on the z axis, in meters.
IlvHorizontalShiftDatum::IlvHorizontalShiftDatum ( const IlvHorizontalShiftDatum source)

Initializes a new instance of the IlvHorizontalShiftDatum by copying specified horizontal shift datum.

Parameters
sourceThe source datum to be copied.

Member Function Documentation

IlBoolean IlvHorizontalShiftDatum::equivalent ( const IlvHorizontalDatum datum) const
virtual

Returns IlTrue if the specified datum is equivalent to this.

Parameters
datumThe datum to test against.
Returns
IlTrue if the specified datum describes the same coordinate system as this datum.

Implements IlvHorizontalDatum.


© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.