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

srm::Coord2D_LocalSpacePolar Class Reference

A Coord2D for SRF_LocalSpacePolar. More...

#include <LocalSpacePolar.h>

Inheritance diagram for srm::Coord2D_LocalSpacePolar:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Coord2D_LocalSpacePolar (SRF_LocalSpacePolar *srf, SRM_Long_Float angle=0.0, SRM_Long_Float radius=0.0)
 Constructor.

 Coord2D_LocalSpacePolar (const Coord2D_LocalSpacePolar &coord)
 Copy constructor.

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

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

void setComponentValues (SRM_Long_Float angle, SRM_Long_Float radius)
 Sets all coordinate component values.

SRM_Long_Float get_radius () const
 Returns the radius value.

SRM_Long_Float get_angle () const
 Returns the angle value.

void set_radius (SRM_Long_Float value)
 Sets the radius value.

void set_angle (SRM_Long_Float value)
 Sets the angle 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 Coord2D_LocalSpacePolar &rhs) const
 The equality operator.

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

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

Detailed Description

A Coord2D for SRF_LocalSpacePolar.

Author:
David Shen
See also:
SRF_LocalSpacePolar

Definition at line 169 of file LocalSpacePolar.h.

Member Function Documentation

void srm::Coord2D_LocalSpacePolar::copyTo (  Coord2D_LocalSpacePolar &  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 195 of file LocalSpacePolar.h.

bool srm::Coord2D_LocalSpacePolar::isCompatibleWith (  const Coord2D_LocalSpacePolar &  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 270 of file LocalSpacePolar.h.

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

Returns true if the coordinate component values are identical.

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

Definition at line 207 of file LocalSpacePolar.h.

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

The assignment operator.

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

Definition at line 279 of file LocalSpacePolar.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