rwlogo

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
List of all members | Public Member Functions
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

Public Member Functions

 IlvLambertEqualAreaConicProjection ()
 Constructor. More...
 
 IlvLambertEqualAreaConicProjection (IlDouble lat1, IlBoolean south=IlFalse)
 Initializes an instance of IlvLambertEqualAreaConicProjection with specified secant latitude. More...
 
IlBoolean isSouth ()
 Checks if the projection is set for the South Pole. More...
 
virtual IlvMapsError setSecantLatitudes (const IlvCoordinate &secant)
 Sets the latitudes at which the cone intersects with the earth. More...
 
void setSouth (IlBoolean south)
 Sets the projection either for the South Pole or for the North Pole. More...
 
virtual void write (IlvOutputFile &f) const
 Saves the parameters of a projection to the specified output file. More...
 
- Public Member Functions inherited from IlvAlbersEqualAreaProjection
 IlvAlbersEqualAreaProjection (IlDouble lat1=IlvMaps::DegreeToRadian(29.5), IlDouble lat2=IlvMaps::DegreeToRadian(45.5))
 This constructor initializes an instance of the class IlvAlbersEqualAreaProjection. More...
 
virtual IlvMapsError setEllipsoid (const IlvEllipsoid &ellipsoid)
 Sets the ellipsoid used for the projection. More...
 
virtual void setLLCenter (IlDouble lon, IlDouble lat)
 Specifies the central meridian and the central parallel (in radian) associated with the projection. More...
 
- Public Member Functions inherited from IlvConicProjection
virtual IlvProjectionClassInfogetClassInfo () const
 Returns the class information for the projection. More...
 
IlDouble getSecantLatitude1 (void) const
 Gets the first secant latitude. More...
 
IlDouble getSecantLatitude2 (void) const
 Gets the second secant latitude. More...
 
const IlvCoordinategetSecantLatitudes () const
 Returns the secant latitudes of the projection in an IlvCoordinate. More...
 
IlvMapsError setSecantLatitude1 (IlDouble v)
 Sets the first secant latitude. More...
 
IlvMapsError setSecantLatitude2 (IlDouble v)
 Sets the second secant latitude. More...
 
- Public Member Functions inherited from IlvProjection
virtual IlvProjectioncopy () const =0
 Returns a copy of the projection. It must be overridden in each subclass. More...
 
IlvMapsError forward (const IlvCoordinate &llIn, IlvCoordinate &xyOut) const
 Converts a latitude and a longitude to Cartesian coordinates (x,y). More...
 
IlvMapsError forward (IlvCoordinate &x) const
 This member function converts a latitude and a longitude to Cartesian coordinates. More...
 
IlDouble getCentralMeridian () const
 Returns the central meridian of the projection. More...
 
IlDouble getCentralParallel () const
 Returns the central parallel of the projection. More...
 
const IlvHorizontalDatumgetDatum (void) const
 Returns the horizontal datum used for the projection. More...
 
const IlvEllipsoidgetEllipsoid (void) const
 Returns the ellipsoid used for the projection. More...
 
IlvMapsError getError () const
 Returns the status of the projection. If the projection is valid, the function returns IlvMapsError::NoError(), otherwise, it returns an error code. See the IlvMaps class to know how to interpret the error codes. More...
 
IlDouble getFalseEasting () const
 Returns the false easting of the projection. More...
 
IlDouble getFalseNorthing () const
 Returns the false northing of the projection. More...
 
IlvProjectionInterfacegetInterface ()
 Returns the interface of the projection. More...
 
IlvCoordinate getLLCenter (void) const
 Returns the central meridian and the central parallel associated with the projection (0-0 by default). More...
 
IlvProjectionGeometricProperty getProperty () const
 Returns the geometric property of the projection. More...
 
const IlvUnitConvertergetUnitConverter () const
 Returns the unit converter. More...
 
IlvCoordinate getXYOffset (void) const
 Returns the false easting and the false northing of the projection. More...
 
IlvMapsError inverse (const IlvCoordinate &xyIn, IlvCoordinate &llOut) const
 Converts the specified coordinate to a latitude and a longitude. More...
 
IlvMapsError inverse (IlvCoordinate &x) const
 Converts the IlvCoordinate representing Cartesian coordinates to a latitude and a longitude. More...
 
IlBoolean isBad () const
 Checks for an inconsistent state of the projection. More...
 
IlBoolean isEllipsoidEnabled () const
 Returns IlTrue if non spherical ellipsoids can be used for the projection. More...
 
IlBoolean isGeocentric () const
 Checks if the projection uses geocentric latitudes. More...
 
IlBoolean isInverseEnabled () const
 Returns IlTrue if the inverse function is supported by the projection. More...
 
IlBoolean isShared () const
 Returns IlTrue if the projection is shared. More...
 
IlBoolean isUsingLongitudeReduction () const
 Returns IlTrue if the projection uses range reduction for longitudes. More...
 
void lock ()
 Locks the projection.
 
virtual IL_STDPREF ostream & printPROJ4Descriptor (IL_STDPREF ostream &ostr, IlvMapsError *status=0) const
 This virtual member function converts the projection to a string in the PROJ4 format. More...
 
void save (IlvOutputFile &outputFile) const
 Saves an instance of a subclass of IlvProjection to the specified output file. More...
 
void setCentralMeridian (IlDouble lon)
 Sets the central meridian of the projection. More...
 
void setCentralParallel (IlDouble lat)
 Sets the central parallel of the projection. More...
 
virtual IlvMapsError setDatum (const IlvHorizontalDatum *datum)
 Sets the datum used for the projection. More...
 
void setFalseEasting (IlDouble falseEasting)
 Sets the false easting of the projection. More...
 
void setFalseNorthing (IlDouble falseNorthing)
 Sets the false northing of the projection. More...
 
void setGeocentric (IlBoolean geoc)
 Specifies whether the projection uses geocentric or geodetic latitudes. More...
 
void setShared ()
 Specifies that the projection will be shared. More...
 
void setUnitConverter (const IlvUnitConverter &converter)
 Sets the unit converter of the projection. The default unit is meters. More...
 
void setUsingLongitudeReduction (IlBoolean use)
 Specifies whether the projection uses longitude reduction. More...
 
void setXYOffset (IlDouble x0, IlDouble y0)
 Specifies the false easting and the false northing. More...
 
void unLock ()
 Unlocks the object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvProjection
static IlvProjectionClassInfoClassInfo ()
 Returns the class information of the class. More...
 
static IlvClassInfo ** ClassInfoRef ()
 Returns the address of the class information of the class. More...
 
static IlvMapsError InputError ()
 Returned if the coordinates passed to the forward function are not in a valid range for radian angles.
 
static IlvMapsError InvalidEllipsoidError ()
 Returned if you attempt to set a non spherical ellipsoid to a projection that does not support non spherical ellipsoids.
 
static IlvProjectionLoad (IlvInputFile &inputFile)
 Loads a projection from the specified file. More...
 
static IlvProjectionPROJ4ToIlvProjection (const char *PROJ4descriptor, IlvMapsError *status=0)
 Creates the projection specified by proj4Descriptor. More...
 
static IlvMapsError ToleranceConditionError ()
 Returned when an internal projection computation fails. Some projections, however, can return more specific error codes in this case.
 
static IlvMapsError UnsupportedFeatureError ()
 Returned if an unsupported projection feature is requested, like inverse projection for a projection that does not support inverse projection.
 
- Protected Member Functions inherited from IlvAlbersEqualAreaProjection
virtual IlvMapsError eForward (IlvCoordinate &ll) const
 Must be redefined in subclasses to implement the projection for a non spherical ellipsoid. More...
 
virtual IlvMapsError eInverse (IlvCoordinate &xy) const
 Implements the inverse projection for a non spherical ellipsoid. More...
 
virtual IlvMapsError sForward (IlvCoordinate &ll) const
 Must be redefined in subclasses to implement the projection for a sphere. More...
 
virtual IlvMapsError sInverse (IlvCoordinate &xy) const
 Must be redefined in subclasses to implement the inverse projection for a sphere. More...
 

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.


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
lat1The first secant latitude in radians.
southSpecifies if the projection is set for the southern hemisphere.

Member Function Documentation

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
secantAn 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
southSpecifies 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
outputFileThe file to write the projection parameters to.

Reimplemented from IlvAlbersEqualAreaProjection.


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