cds.simbad
Class CooFrame

java.lang.Object
  extended bycds.simbad.CooFrame

public class CooFrame
extends java.lang.Object

Used as a structure for managing a coordinate frame.

Version:
1.0 Apr 2002, 1.1 Jan 2004 Ajout de la methode equals.
Author:
Marc Wenger/CDS, Benoit Baranne (Stagiaire UTBM)

Field Summary
(package private)  java.lang.String cooEpoch
           
(package private)  java.lang.String cooEquinox
           
(package private)  java.lang.String cooFrame
           
 
Constructor Summary
CooFrame()
          creates a default CooFrame object with ICRS,2000,2000
CooFrame(CooFrame cf)
          Copy constructor.
CooFrame(java.lang.String frame, java.lang.String epoch)
          creates a CooFrame object with the specified parameters.
CooFrame(java.lang.String frame, java.lang.String equinox, java.lang.String epoch)
          creates a CooFrame object with the specified parameters
 
Method Summary
 boolean equals(java.lang.Object o)
          MOD-BB 21-01-04 Ajout de cette methode.
 java.lang.String getEpoch()
          Gets the epoch
 java.lang.String getEquinox()
          Gets the equinox
 java.lang.String getFrame()
          Gets the frame
 void set(CooFrame cf)
          Sets the ooFrame object from another one
 CooFrame setEpoch(java.lang.String epoch)
          Sets the epoch
 CooFrame setEquinox(java.lang.String equi)
          Sets the equinox
 CooFrame setFrame(java.lang.String frame)
          Sets the frame
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

cooFrame

java.lang.String cooFrame

cooEquinox

java.lang.String cooEquinox

cooEpoch

java.lang.String cooEpoch
Constructor Detail

CooFrame

public CooFrame()
creates a default CooFrame object with ICRS,2000,2000


CooFrame

public CooFrame(java.lang.String frame,
                java.lang.String equinox,
                java.lang.String epoch)
creates a CooFrame object with the specified parameters

Parameters:
frame - Frame. it must belong to ICRS,FK4,FK5,GAL,SGAL,ECL
equinox - Equinox year
epoch - Epoch year

CooFrame

public CooFrame(java.lang.String frame,
                java.lang.String epoch)
creates a CooFrame object with the specified parameters. The equinox is is set to 2000.0 for the frames which require equinox to be set.

Parameters:
frame - Frame. it must belong to ICRS,FK4,FK5,GAL,SGAL,ECL
epoch - Epoch year

CooFrame

public CooFrame(CooFrame cf)
Copy constructor. CReates the CooFrame object from another one

Parameters:
cf - Cooframe object to copy
Method Detail

set

public void set(CooFrame cf)
Sets the ooFrame object from another one

Parameters:
cf - CooFrame from which the values will be copied

setFrame

public CooFrame setFrame(java.lang.String frame)
Sets the frame

Parameters:
frame - Frame. it must belong to ICRS,FK4,FK5,GAL,SGAL,ECL
Returns:
the CooFrame object

setEquinox

public CooFrame setEquinox(java.lang.String equi)
Sets the equinox

Parameters:
equi - Equinox year
Returns:
the CooFrame object

setEpoch

public CooFrame setEpoch(java.lang.String epoch)
Sets the epoch

Parameters:
epoch - Epoch year
Returns:
the CooFrame object

getFrame

public java.lang.String getFrame()
Gets the frame

Returns:
The frame string

getEquinox

public java.lang.String getEquinox()
Gets the equinox

Returns:
The equinox as a string

getEpoch

public java.lang.String getEpoch()
Gets the epoch

Returns:
The epoch as a string

equals

public boolean equals(java.lang.Object o)
MOD-BB 21-01-04 Ajout de cette methode. Comparaison de CooFrame.

Parameters:
o - Objet a comparer.
Returns:
Vrai si o est identique a this, faux sinon.