Main Page | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members

srm::SRF_PolarStereographic Class Reference

SRF_PolarStereographic class declaration. More...

#include <PolarStereographic.h>

Inheritance diagram for srm::SRF_PolarStereographic:

Inheritance graph
[legend]
Collaboration diagram for srm::SRF_PolarStereographic:

Collaboration graph
[legend]
List of all members.

Public Member Functions

Coord3D * createCoordinate3D (SRM_Long_Float coord_comp1, SRM_Long_Float coord_comp2, SRM_Long_Float coord_comp3)
 Returns a 3D coordinate object.

CoordSurf * createSurfaceCoordinate (SRM_Long_Float coord_surf_comp1, SRM_Long_Float coord_surf_comp2)
 Returns a surface coordinate object.

const SRM_PS_Parameters & getSRFParameters () const
 Returns a reference to the SRF parameter structure.

SRM_Polar_Aspect get_polar_aspect () const
 Returns the polar_aspect SRF parameter value.

SRM_Long_Float get_origin_longitude () const
 Returns the origin_longitude SRF parameter value.

SRM_Long_Float get_central_scale () const
 Returns the central_scale SRF parameter value.

SRM_Long_Float get_false_easting () const
 Returns the false_easting SRF parameter value.

SRM_Long_Float get_false_northing () const
 Returns the false_northing SRF parameter value.

virtual bool isA (SRF_ClassType type) const
 Returns true if this SRF is of the given class type.

virtual SRF_ClassType getClassType () const
 Returns the class type of this SRF instance.

bool isEqual (const SRF_PolarStereographic &srf) const
 Returns true if the SRF parameters are equal.

bool operator== (const SRF_PolarStereographic &rhs) const
 The equality operator.

SRF_PolarStereographic * makeCopy () const
 Returns a copy of this SRF object.

virtual SRM_Coordinate_Valid_Region changeCoordinate3DSRF (const Coord3D &src_coord, Coord3D &des_coord)
 Changes a coordinate's values to this SRF (optimized implementation).

const char * toString ()
 Returns char* of parameter names and their values.


Static Public Member Functions

SRF_PolarStereographic * create (SRM_ORM_Code orm, SRM_RT_Code rt, const SRM_PS_Parameters &params)
 Constructor by SRF parameter structure.

SRF_PolarStereographic * create (SRM_ORM_Code orm, SRM_RT_Code rt, SRM_Polar_Aspect polar_aspect, SRM_Long_Float origin_longitude, SRM_Long_Float central_scale, SRM_Long_Float false_easting, SRM_Long_Float false_northing)
 Constructor by individual SRF parameters.

SRF_PolarStereographic * create (SRM_SRF_Parameters_Info srf_params)
 SRF_PolarStereographic constructor by SRF parameter structure.


Protected Member Functions

 SRF_PolarStereographic (void *impl)
 No stack allocation.

SRF_PolarStereographic & operator= (const SRF_PolarStereographic &)
 No copy constructor.

virtual ~SRF_PolarStereographic ()
 Use release().


Friends

class BaseSRF
class BaseSRF_3D
class BaseSRF_WithEllipsoidalHeight

Detailed Description

SRF_PolarStereographic class declaration.

SRFs are allocated by the API, and when no longer needed they should be released by calling the release() method.

Author:
David Shen
See also:
BaseSRF_MapProjection

Definition at line 91 of file PolarStereographic.h.

Member Function Documentation

virtual SRM_Coordinate_Valid_Region srm::SRF_PolarStereographic::changeCoordinate3DSRF (  const Coord3D &  src_coord,
Coord3D &  des_coord
)  [virtual]
 

Changes a coordinate's values to this SRF (optimized implementation).

Note:
The destination coordinate must have been created using this SRF.
Parameters:
src_coord in: the source coordinate in some other SRF
des_coord in/out: the destination coordinate in this SRF
Returns:
validity code for the destination coordinate
Exceptions:
This method throws srm::Exception

Reimplemented from srm::BaseSRF_3D.

SRF_PolarStereographic* srm::SRF_PolarStereographic::create (  SRM_SRF_Parameters_Info  srf_params  )  [inline, static]
 

SRF_PolarStereographic constructor by SRF parameter structure.

Exceptions:
This method throws srm::Exception

Definition at line 117 of file PolarStereographic.h.

SRF_PolarStereographic* srm::SRF_PolarStereographic::create (  SRM_ORM_Code  orm,
SRM_RT_Code  rt,
SRM_Polar_Aspect  polar_aspect,
SRM_Long_Float  origin_longitude,
SRM_Long_Float  central_scale,
SRM_Long_Float  false_easting,
SRM_Long_Float  false_northing
)  [static]
 

Constructor by individual SRF parameters.

Exceptions:
This method throws srm::Exception

SRF_PolarStereographic* srm::SRF_PolarStereographic::create (  SRM_ORM_Code  orm,
SRM_RT_Code  rt,
const SRM_PS_Parameters &  params
)  [static]
 

Constructor by SRF parameter structure.

Exceptions:
This method throws srm::Exception

SRM_Long_Float srm::SRF_PolarStereographic::get_central_scale (   )  const
 

Returns the central_scale SRF parameter value.

Exceptions:
This method throws srm::Exception

SRM_Long_Float srm::SRF_PolarStereographic::get_false_easting (   )  const
 

Returns the false_easting SRF parameter value.

Exceptions:
This method throws srm::Exception

SRM_Long_Float srm::SRF_PolarStereographic::get_false_northing (   )  const
 

Returns the false_northing SRF parameter value.

Exceptions:
This method throws srm::Exception

SRM_Long_Float srm::SRF_PolarStereographic::get_origin_longitude (   )  const
 

Returns the origin_longitude SRF parameter value.

Exceptions:
This method throws srm::Exception

SRM_Polar_Aspect srm::SRF_PolarStereographic::get_polar_aspect (   )  const
 

Returns the polar_aspect SRF parameter value.

Exceptions:
This method throws srm::Exception

const SRM_PS_Parameters& srm::SRF_PolarStereographic::getSRFParameters (   )  const
 

Returns a reference to the SRF parameter structure.

Exceptions:
This method throws srm::Exception

bool srm::SRF_PolarStereographic::isEqual (  const SRF_PolarStereographic &  srf  )  const
 

Returns true if the SRF parameters are equal.

Note:
This method is deprecated. Use the equality operator instead.

SRF_PolarStereographic* srm::SRF_PolarStereographic::makeCopy (   )  const
 

Returns a copy of this SRF object.

Exceptions:
This method throws srm::Exception

bool srm::SRF_PolarStereographic::operator== (  const SRF_PolarStereographic &  rhs  )  const
 

The equality operator.

Note:
This operator returns true if the SRFs have identical parameter values.

const char* srm::SRF_PolarStereographic::toString (   )  [virtual]
 

Returns char* of parameter names and their values.

Exceptions:
This method throws srm::Exception

Implements srm::BaseSRF.

The documentation for this class was generated from the following file:
Spatial Reference Model C++ API Version 4.4 - December 7, 2009
Copyright © 2009 SEDRIS™ Docs by Doxygen 1.3.2