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

srm::Coord3D_PolarStereographic Class Reference

A Coord3D for SRF_PolarStereographic. More...

#include <PolarStereographic.h>

Inheritance diagram for srm::Coord3D_PolarStereographic:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Coord3D_PolarStereographic (SRF_PolarStereographic *srf, SRM_Long_Float easting=0.0, SRM_Long_Float northing=0.0, SRM_Long_Float ellipsoidal_height=0.0)
 Constructor.

 Coord3D_PolarStereographic (const Coord3D_PolarStereographic &coord)
 Copy constructor.

void copyTo (Coord3D_PolarStereographic &coord) const
 Copies component values to the coordinate.

bool isEqual (const Coord3D_PolarStereographic &coord) const
 Returns true if the coordinate component values are identical.

void setComponentValues (SRM_Long_Float easting, SRM_Long_Float northing, SRM_Long_Float ellipsoidal_height)
 Sets all coordinate component values.

SRM_Long_Float get_easting () const
 Returns the easting value.

SRM_Long_Float get_northing () const
 Returns the northing value.

SRM_Long_Float get_ellipsoidal_height () const
 Returns the ellipsoidal_height value.

void set_easting (SRM_Long_Float value)
 Sets the easting value.

void set_northing (SRM_Long_Float value)
 Sets the northing value.

void set_ellipsoidal_height (SRM_Long_Float value)
 Sets the ellipsoidal_height value.

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

virtual Coord_ClassType getClassType () const
 Returns true if this SRF is of the given class type.

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

bool isCompatibleWith (const Coord3D_PolarStereographic &rhs) const
 Returns true if the coordinates are associated with SRFs with identical parameters.

Coord3D_PolarStereographic & operator= (const Coord3D_PolarStereographic &rhs)
 The assignment operator.

Detailed Description

A Coord3D for SRF_PolarStereographic.

Author:
David Shen
See also:
SRF_PolarStereographic

Definition at line 233 of file PolarStereographic.h.

Member Function Documentation

void srm::Coord3D_PolarStereographic::copyTo (  Coord3D_PolarStereographic &  coord  )  const [inline]
 

Copies component values to the coordinate.

Note:
The coordinates must be associated with the same SRF instance.

This method is deprecated. Use the assignment operator.

Exceptions:
This method throws srm::Exception

Definition at line 260 of file PolarStereographic.h.

bool srm::Coord3D_PolarStereographic::isCompatibleWith (  const Coord3D_PolarStereographic &  rhs  )  const [inline]
 

Returns true if the coordinates are associated with SRFs with identical parameters.

Note:
This method should be used to evaluate coordinate compatibility before calling the coordinate assignment operator to avoid raising runtime exception when operating on incompatible coordinates.

Definition at line 352 of file PolarStereographic.h.

bool srm::Coord3D_PolarStereographic::isEqual (  const Coord3D_PolarStereographic &  coord  )  const [inline]
 

Returns true if the coordinate component values are identical.

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

Definition at line 273 of file PolarStereographic.h.

Coord3D_PolarStereographic& srm::Coord3D_PolarStereographic::operator= (  const Coord3D_PolarStereographic &  rhs  )  [inline]
 

The assignment operator.

Note:
This operator will check whether the coordinates are compatible.
Exceptions:
This method throws srm::Exception

Definition at line 361 of file PolarStereographic.h.

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