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

srm::Coord3D_HeliosphericEarthEquatorial Class Reference

A Coord3D for SRF_HeliosphericEarthEquatorial. More...

#include <HeliosphericEarthEquatorial.h>

Inheritance diagram for srm::Coord3D_HeliosphericEarthEquatorial:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Coord3D_HeliosphericEarthEquatorial (SRF_HeliosphericEarthEquatorial *srf, SRM_Long_Float longitude=0.0, SRM_Long_Float latitude=0.0, SRM_Long_Float radius=0.0)
 Constructor.

 Coord3D_HeliosphericEarthEquatorial (const Coord3D_HeliosphericEarthEquatorial &coord)
 Copy constructor.

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

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

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

SRM_Long_Float get_longitude () const
 Returns the longitude value.

SRM_Long_Float get_latitude () const
 Returns the latitude value.

SRM_Long_Float get_radius () const
 Returns the radius value.

void set_longitude (SRM_Long_Float value)
 Sets the longitude value.

void set_latitude (SRM_Long_Float value)
 Sets the latitude value.

void set_radius (SRM_Long_Float value)
 Sets the radius 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_HeliosphericEarthEquatorial &rhs) const
 The equality operator.

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

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

Detailed Description

A Coord3D for SRF_HeliosphericEarthEquatorial.

Author:
David Shen
See also:
SRF_HeliosphericEarthEquatorial

Definition at line 170 of file HeliosphericEarthEquatorial.h.

Member Function Documentation

void srm::Coord3D_HeliosphericEarthEquatorial::copyTo (  Coord3D_HeliosphericEarthEquatorial &  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 197 of file HeliosphericEarthEquatorial.h.

bool srm::Coord3D_HeliosphericEarthEquatorial::isCompatibleWith (  const Coord3D_HeliosphericEarthEquatorial &  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 289 of file HeliosphericEarthEquatorial.h.

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

Returns true if the coordinate component values are identical.

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

Definition at line 210 of file HeliosphericEarthEquatorial.h.

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

The assignment operator.

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

Definition at line 298 of file HeliosphericEarthEquatorial.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