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

srm::CoordSurf_Mercator Class Reference

A CoordSurf for SRF_Mercator. More...

#include <Mercator.h>

Inheritance diagram for srm::CoordSurf_Mercator:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 CoordSurf_Mercator (SRF_Mercator *srf, SRM_Long_Float easting=0.0, SRM_Long_Float northing=0.0)
 Constructor.

 CoordSurf_Mercator (const CoordSurf_Mercator &coord)
 Copy constructor.

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

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

void setComponentValues (SRM_Long_Float easting, SRM_Long_Float northing)
 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.

void set_easting (SRM_Long_Float value)
 Sets the easting value.

void set_northing (SRM_Long_Float value)
 Sets the northing 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 CoordSurf_Mercator &rhs) const
 The equality operator.

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

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

Detailed Description

A CoordSurf for SRF_Mercator.

Author:
David Shen
See also:
SRF_Mercator

Definition at line 387 of file Mercator.h.

Member Function Documentation

void srm::CoordSurf_Mercator::copyTo (  CoordSurf_Mercator &  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 413 of file Mercator.h.

bool srm::CoordSurf_Mercator::isCompatibleWith (  const CoordSurf_Mercator &  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 488 of file Mercator.h.

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

Returns true if the coordinate component values are identical.

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

Definition at line 425 of file Mercator.h.

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

The assignment operator.

Note:
This operator will check whether the coordinates are compatible.

Compatible coordinates are associated with SRFs with identical parameters.

Exceptions:
This method throws srm::Exception

Definition at line 498 of file Mercator.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