IlvHorizontalDatum Class Reference

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

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

Inheritance diagram for IlvHorizontalDatum:

Public Member Functions
virtual IlvHorizontalDatum *	copy () const =0
	Returns a new copy of this datum.
virtual IlBoolean	equivalent (const IlvHorizontalDatum *datum) const =0
	Indicates if the specified datum is equivalent to this object. More...
const IlvEllipsoid *	getEllipsoid () 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 output file. 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 IlvHorizontalDatum *	Load (IlvInputFile &inputFile)
	This static method loads a datum from the specified file. More...

Protected Member Functions
	IlvHorizontalDatum (const IlvEllipsoid &ellipsoid)
	Initializes a new IlvHorizontalDatum instance. More...
	IlvHorizontalDatum (const IlvHorizontalDatum &source)
	Initializes a new IlvHorizontalDatum instance, copying the specified datum. More...
	IlvHorizontalDatum (IlvInputFile &file)
	Initializes a new 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() [1/3]

IlvHorizontalDatum::IlvHorizontalDatum ( const IlvEllipsoid &  ellipsoid )

protected

Initializes a new IlvHorizontalDatum instance.

Parameters

ellipsoid

The ellipsoid for this datum.

IlvHorizontalDatum() [2/3]

IlvHorizontalDatum::IlvHorizontalDatum ( const IlvHorizontalDatum &  source )

protected

Initializes a new IlvHorizontalDatum instance, copying the specified datum.

Parameters

source

The source datum.

IlvHorizontalDatum() [3/3]

IlvHorizontalDatum::IlvHorizontalDatum ( IlvInputFile &  file )

protected

Initializes a new IlvHorizontalDatum from specified input file.

Parameters

file	The input file.

Member Function Documentation

equivalent()

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

pure virtual

Indicates if the specified datum is equivalent to this object.

Parameters

datum

The datum to test against.

Returns

IlTrue if the specified datum describes the same coordinate system as this datum.

Implemented in IlvHorizontalShiftDatum.

GetConverterFactory()

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.

getEllipsoid()

const IlvEllipsoid* IlvHorizontalDatum::getEllipsoid

(

)

const

Returns the ellipsoid for this datum.

Returns

The ellipsoid for this datum.

getInitStatus()

IlvMapsError IlvHorizontalDatum::getInitStatus

(

)

const

Returns the initialization status of this datum.

Returns

IlvMaps::NoError() if this datum has been initialized successfully, an error otherwise.

Load()

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

inputFile

The file to read the projection from.

Returns

The read IlvHorizontalDatum or a null pointer if the load operation fails.

See also

IlvHorizontalDatum::getInitStatus()

save()

void IlvHorizontalDatum::save

(

IlvOutputFile &

file

)

const

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

Parameters

file	The file to write the datum to.

setInitStatus()

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

status

The initialization status.

write()

virtual void IlvHorizontalDatum::write ( IlvOutputFile &  file ) const

virtual

Write the object to an output file.

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

file	The output file.