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

srm::Coord3D_SolarMagneticEcliptic Class Reference

A Coord3D for SRF_SolarMagneticEcliptic. More...

#include <SolarMagneticEcliptic.h>

Inheritance diagram for srm::Coord3D_SolarMagneticEcliptic:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Coord3D_SolarMagneticEcliptic (SRF_SolarMagneticEcliptic *srf, SRM_Long_Float u=0.0, SRM_Long_Float v=0.0, SRM_Long_Float w=0.0)
 Constructor.

 Coord3D_SolarMagneticEcliptic (const Coord3D_SolarMagneticEcliptic &coord)
 Copy constructor.

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

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

void setComponentValues (SRM_Long_Float u, SRM_Long_Float v, SRM_Long_Float w)
 Sets all coordinate component values.

SRM_Long_Float get_u () const
 Returns the u value.

SRM_Long_Float get_v () const
 Returns the v value.

SRM_Long_Float get_w () const
 Returns the w value.

void set_u (SRM_Long_Float value)
 Sets the u value.

void set_v (SRM_Long_Float value)
 Sets the v value.

void set_w (SRM_Long_Float value)
 Sets the w 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_SolarMagneticEcliptic &rhs) const
 The equality operator.

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

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

Detailed Description

A Coord3D for SRF_SolarMagneticEcliptic.

Author:
David Shen
See also:
SRF_SolarMagneticEcliptic

Definition at line 170 of file SolarMagneticEcliptic.h.

Member Function Documentation

void srm::Coord3D_SolarMagneticEcliptic::copyTo (  Coord3D_SolarMagneticEcliptic &  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 SolarMagneticEcliptic.h.

bool srm::Coord3D_SolarMagneticEcliptic::isCompatibleWith (  const Coord3D_SolarMagneticEcliptic &  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 288 of file SolarMagneticEcliptic.h.

bool srm::Coord3D_SolarMagneticEcliptic::isEqual (  const Coord3D_SolarMagneticEcliptic &  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 SolarMagneticEcliptic.h.

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

The assignment operator.

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

Definition at line 297 of file SolarMagneticEcliptic.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