rwlogo
Rogue Wave Views 5.6

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 | Protected Member Functions
IlvHorizontalDatum Class Referenceabstract

This abstract class is the base class for classes describing a horizontal datum. More...

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

Inheritance diagram for IlvHorizontalDatum:
IlvHorizontalShiftDatum

Public Member Functions

virtual IlvHorizontalDatumcopy () const =0
 Returns a new copy of this datum.
 
virtual IlBoolean equivalent (const IlvHorizontalDatum *d) const =0
 Returns IlTrue if the specified datum is equivalent to this. More...
 
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
IlvHorizontalDatumConverterFactory
GetConverterFactory ()
 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...
 

Protected Member Functions

 IlvHorizontalDatum (const IlvEllipsoid &ellipsoid)
 Initializes a new instance of IlvHorizontalDatum. More...
 
 IlvHorizontalDatum (const IlvHorizontalDatum &datum)
 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 abstract class is the base class for classes describing a horizontal datum.

Library: ilvmaps

Constructor & Destructor Documentation

IlvHorizontalDatum::IlvHorizontalDatum ( const IlvEllipsoid ellipsoid)
protected

Initializes a new instance of IlvHorizontalDatum.

Parameters
ellipsoidThe ellipsoid for this datum.
IlvHorizontalDatum::IlvHorizontalDatum ( const IlvHorizontalDatum datum)
protected

Initializes a new instance of IlvHorizontalDatum, copying the specified datum.

Parameters
sourceThe source datum.
IlvHorizontalDatum::IlvHorizontalDatum ( IlvInputFile file)
protected

Reads an IlvHorizontalDatum from specified input file.

Parameters
fileThe input file.

Member Function Documentation

virtual IlBoolean IlvHorizontalDatum::equivalent ( const IlvHorizontalDatum d) const
pure 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.

Implemented in IlvHorizontalShiftDatum.

static const IlvHorizontalDatumConverterFactory* IlvHorizontalDatum::GetConverterFactory ( )
static

Returns a factory than can create converters to convert coordinates from one datum to another.

The default factory supports the conversion using the Molodensky formula.

Returns
A factory to convert coordinates between datums.
const IlvEllipsoid* IlvHorizontalDatum::getEllipsoid ( ) const

Returns the ellipsoid for this datum.

Returns
The ellipsoid for this datum.
IlvMapsError IlvHorizontalDatum::getInitStatus ( ) const

Returns the initialization status of this datum.

Returns
IlvMaps::NoError() if this datum has been initialized successfully, an error otherwise.
static IlvHorizontalDatum* IlvHorizontalDatum::Load ( IlvInputFile inputFile)
static

This static method loads a datum from the specified file.

If the load operation fails, this function returns a null pointer, otherwise, it returns a pointer to the datum which was read. If the file contained invalid parameters, the returned datum can have an error status.

The returned datum must be deleted by the user.

Parameters
inputFileThe file to read the projection from.
Returns
The read IlvHorizontalDatum or a null pointer if the load operation fails.
See Also
IlvHorizontalDatum::getInitStatus()
void IlvHorizontalDatum::save ( IlvOutputFile file) const

Saves an instance of a subclass of IlvHorizontalDatum to the specified output file.

Parameters
fileThe file to write the datum to.
void IlvHorizontalDatum::setInitStatus ( IlvMapsError  status)
protected

Sets the initialization status of this datum.

This method sets the initialization status of this datum. Subclasses of IlvHorizontalDatum should call this method when their initialization is not successful.

Parameters
statusThe initialization status.
virtual void IlvHorizontalDatum::write ( IlvOutputFile file) const
virtual

Write the object to an IlvOutputFile.

This method saves the parameters of a horizontal datum to the specified output file. This method has to be overridden by subclasses of IlvHorizontalDatum that need to save additional parameters.

This method should not be directly called. The method save() should be used instead.

Parameters
fileThe output file.

© Copyright 2012, 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.