rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvLambertEqualAreaConicProjection Class Reference

This class defines the Lambert Equal Area Conic projection. More...

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

Inheritance diagram for IlvLambertEqualAreaConicProjection:
IlvAlbersEqualAreaProjection IlvConicProjection IlvProjection

List of all members.

Public Member Functions

 IlvLambertEqualAreaConicProjection (IlDouble lat1, IlBoolean south=IlFalse)
 Initializes an instance of IlvLambertEqualAreaConicProjection with specified secant latitude.
 IlvLambertEqualAreaConicProjection ()
 Constructor.
virtual IlvProjectioncopy () const
 Returns a copy of the projection. It must be overridden in each subclass.
virtual IlvProjectionClassInfogetClassInfo () const
 Returns the class information for the projection.
IlBoolean isSouth ()
 Checks if the projection is set for the South Pole.
virtual IlvMapsError setSecantLatitudes (const IlvCoordinate &secant)
 Sets the latitudes at which the cone intersects with the earth.
void setSouth (IlBoolean south)
 Sets the projection either for the South Pole or for the North Pole.
virtual void write (IlvOutputFile &f) 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.

Detailed Description

This class defines the Lambert Equal Area Conic projection.

The Lambert Equal Area projection is a special form of the Albers Equal Area projection where the second secant latitude is always set to a pole, either the south pole or the north pole.

This projection applies both to spherical and non-spherical ellipsoids and implements an inverse function.

This projection is Equal Area.

LambertEqualAreaConic.jpg


Lambert Equal Area Conic Projection

Library: ilvmaps


Constructor & Destructor Documentation

IlvLambertEqualAreaConicProjection::IlvLambertEqualAreaConicProjection (  ) 

Constructor.

This constructor initializes an instance of IlvLambertEqualAreaConicProjection with its secant latitudes set to 0N and 90N.

IlvLambertEqualAreaConicProjection::IlvLambertEqualAreaConicProjection ( IlDouble  lat1,
IlBoolean  south = IlFalse 
)

Initializes an instance of IlvLambertEqualAreaConicProjection with specified secant latitude.

Parameters:
lat1 The first secant latitude in radians.
south Specifies if the projection is set for the southern hemisphere.

Member Function Documentation

static IlvProjectionClassInfo* IlvLambertEqualAreaConicProjection::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 IlvAlbersEqualAreaProjection.

static IlvClassInfo** IlvLambertEqualAreaConicProjection::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 IlvAlbersEqualAreaProjection.

virtual IlvProjection* IlvLambertEqualAreaConicProjection::copy (  )  const [virtual]

Returns a copy of the projection. It must be overridden in each subclass.

Returns:
The copy of the object.

Reimplemented from IlvAlbersEqualAreaProjection.

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

Returns the class information for the projection.

Returns:
The class information for the projection.

Reimplemented from IlvAlbersEqualAreaProjection.

IlBoolean IlvLambertEqualAreaConicProjection::isSouth (  ) 

Checks if the projection is set for the South Pole.

This member function returns IlTrue if the projection is set for the South Pole or IlFalse if the projection is set for the North Pole (the default value).

Returns:
IlTrue if the projection is set for the South Pole, IlFalse otherwise.
virtual IlvMapsError IlvLambertEqualAreaConicProjection::setSecantLatitudes ( const IlvCoordinate secant  )  [virtual]

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

Sets the latitudes at which the cone intersects with the earth. The second secant latitude is forced to a pole, depending on the hemisphere shown by the projection.

Parameters:
secant An IlvCoordinate that holds the first secant latitude in x() and the second secant latitude in y().
Returns:
IlvMaps::NoError() if the latitudes have been set successfully, an error otherwise.

Reimplemented from IlvAlbersEqualAreaProjection.

void IlvLambertEqualAreaConicProjection::setSouth ( IlBoolean  south  ) 

Sets the projection either for the South Pole or for the North Pole.

This member function sets the projection either for the South Pole or for the North Pole, depending on the value of the Boolean flag south.

Parameters:
south Specifies if the projection is to be set for the South Pole.
virtual void IlvLambertEqualAreaConicProjection::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 IlvAlbersEqualAreaProjection.


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