rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvConicProjection Class Reference

This abstract class is the base class for all the conic projections in the library. More...

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

Inheritance diagram for IlvConicProjection:
IlvProjection IlvAlbersEqualAreaProjection IlvLambertConformalConicProjection IlvLambertEqualAreaConicProjection IlvFrenchLambertProjection

List of all members.

Public Member Functions

virtual IlvProjectionClassInfogetClassInfo () const
 Returns the class information for the projection.
IlDouble getSecantLatitude1 (void) const
 Gets the first secant latitude.
IlDouble getSecantLatitude2 (void) const
 Gets the second secant latitude.
const IlvCoordinategetSecantLatitudes () const
 Returns the secant latitudes of the projection in an IlvCoordinate.
IlvMapsError setSecantLatitude1 (IlDouble v)
 Sets the first secant latitude.
IlvMapsError setSecantLatitude2 (IlDouble v)
 Sets the second secant latitude.
virtual IlvMapsError setSecantLatitudes (const IlvCoordinate &secant)
 Sets the latitudes at which the cone of the projection intersects with the earth.
virtual void write (IlvOutputFile &) const
 Saves the parameters of a projection to the specified output file.

Static Public Member Functions

static IlvProjectionClassInfoClassInfo ()
 Returns the class information of the class.
static IlvClassInfo ** ClassInfoRef ()
 Returns the address of the class information of the class.

Protected Member Functions

 IlvConicProjection (IlBoolean ellipsoidEnabled, IlBoolean inverseEnabled, IlvProjectionGeometricProperty property, IlStringHashTable *proj4Params=0)
 Initializes a new instance of the class IlvConicProjection.

Detailed Description

This abstract class is the base class for all the conic projections in the library.

A conic projection transfers the image of the globe to a cone, either secant or tangent to the surface of the earth. The latitudes at which the cone intersects with the globe can be specified with the function setSecantLatitudes(IlvCoordinate secant). The secant parameter is a vector that contains two values:

Warning:
[note] The cylindrical (secant.x = - secant.y) or azimuthal (secant.x = secant.y = 90 degrees) limiting forms of a conic projection should not be used. Library: ilvmaps

Constructor & Destructor Documentation

IlvConicProjection::IlvConicProjection ( IlBoolean  ellipsoidEnabled,
IlBoolean  inverseEnabled,
IlvProjectionGeometricProperty  property,
IlStringHashTable *  proj4Params = 0 
) [protected]

Initializes a new instance of the class IlvConicProjection.

Parameters:
ellipsoidEnabled A Boolean argument that should be set to IlTrue if non-spherical ellipsoids can be used for the projection. Projections supporting non-spherical ellipsoids should implement the eForward member function.
inverseEnabled A Boolean argument that should be set to IlTrue if the projection implements an inverse function. This type of projection should implement the sInverse and eInverse member functions if ellipsoids are supported.
property Specifies the geometric property of the projection. This argument can take one of the following values:

  • IlvNoneProjectionGeometricProperty
  • IlvConformalProjectionGeometricProperty
  • IlvEqualAreaProjectionGeometricProperty

Member Function Documentation

static IlvProjectionClassInfo* IlvConicProjection::ClassInfo (  )  [static]

Returns the class information of the class.

This static function is also available for the subclasses of IlvProjection.

Returns:
The IlvProjectionClassInfo of the class.

Reimplemented from IlvProjection.

Reimplemented in IlvAlbersEqualAreaProjection, IlvFrenchLambertProjection, IlvLambertEqualAreaConicProjection, and IlvLambertConformalConicProjection.

static IlvClassInfo** IlvConicProjection::ClassInfoRef (  )  [static]

Returns the address of the class information of the class.

This static function is also available for the subclasses of IlvProjection.

Returns:
The address of the IlvProjectionClassInfo of the class.

Reimplemented from IlvProjection.

Reimplemented in IlvAlbersEqualAreaProjection, IlvFrenchLambertProjection, IlvLambertEqualAreaConicProjection, and IlvLambertConformalConicProjection.

virtual IlvProjectionClassInfo* IlvConicProjection::getClassInfo (  )  const [virtual]

Returns the class information for the projection.

Returns:
The class information for the projection.

Reimplemented from IlvProjection.

Reimplemented in IlvAlbersEqualAreaProjection, IlvFrenchLambertProjection, IlvLambertEqualAreaConicProjection, and IlvLambertConformalConicProjection.

IlDouble IlvConicProjection::getSecantLatitude1 ( void   )  const

Gets the first secant latitude.

Returns:
The first secant latitude.
See also:
IlvConicProjection::getSecantLatitudes.
IlDouble IlvConicProjection::getSecantLatitude2 ( void   )  const

Gets the second secant latitude.

Returns:
The second secant latitude.
See also:
IlvConicProjection::getSecantLatitudes.
const IlvCoordinate& IlvConicProjection::getSecantLatitudes (  )  const

Returns the secant latitudes of the projection in an IlvCoordinate.

Returns:
The IlvCoordinate object containing the secant latitudes.
IlvMapsError IlvConicProjection::setSecantLatitude1 ( IlDouble  v  ) 

Sets the first secant latitude.

Parameters:
v The first secant latitude.
Returns:
An error status if the latitudes specify a limiting form.
See also:
IlvConicProjection::setSecantLatitudes.
IlvMapsError IlvConicProjection::setSecantLatitude2 ( IlDouble  v  ) 

Sets the second secant latitude.

Parameters:
v The second secant latitude.
Returns:
An error status if the latitudes specify a limiting form.
See also:
IlvConicProjection::setSecantLatitudes.
virtual IlvMapsError IlvConicProjection::setSecantLatitudes ( const IlvCoordinate secant  )  [virtual]

Sets the latitudes at which the cone of the projection intersects with the earth.

Parameters:
secant A vector that contains two values: secant.x represents the first latitude at which the cone intersects with the earth. secant.y represents the second latitude at which the cone intersects with the earth.
Both values are expressed in radian.
Returns:
An error status if the latitudes specify a limiting form, that is, if secant.x = -secant.y or secant.x = secant.y = PI/2.

Reimplemented in IlvAlbersEqualAreaProjection, IlvFrenchLambertProjection, IlvLambertEqualAreaConicProjection, and IlvLambertConformalConicProjection.

virtual void IlvConicProjection::write ( IlvOutputFile outputFile  )  const [virtual]

Saves the parameters of a projection to the specified output file.

It must be overridden by subclasses of IlvProjection that need to save additional parameters. This function should not be directly called; use the save function instead.

Parameters:
outputFile The file to write the projection parameters to.

Reimplemented from IlvProjection.

Reimplemented in IlvAlbersEqualAreaProjection, IlvFrenchLambertProjection, IlvLambertEqualAreaConicProjection, and IlvLambertConformalConicProjection.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

© 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.