Jeospace API

org.jeospace.physics.orbit
Interface CelestialBody

All Superinterfaces:
Identifiable

public interface CelestialBody
extends Identifiable

Defines the base requirements for identifying and positioning a celestial body.

Version:
$Revision: 1.1.1.1 $
Author:
Rex Melton
See Also:
Identifiable, Cartesian, Spherical, ReferenceFrame

Method Summary
 void getCoordinate(double timeValue, Cartesian cartesian)
          Calculate the position of the object referenced to it's parent reference frame at the specified time and initialize the argument Cartesian object with the position coordinate.
 void getCoordinate(double timeValue, Spherical spherical)
          Calculate the position of the object referenced to it's parent reference frame at the specified time and initialize the argument Spherical object with the position coordinate.
 ReferenceFrame getReferenceFrame()
          Return the identifier of the object's reference frame.
 
Methods inherited from interface org.jeospace.designation.Identifiable
getIdentification
 

Method Detail

getReferenceFrame

public ReferenceFrame getReferenceFrame()
Return the identifier of the object's reference frame.

Returns:
the ReferenceFrame identifier

getCoordinate

public void getCoordinate(double timeValue,
                          Spherical spherical)
Calculate the position of the object referenced to it's parent reference frame at the specified time and initialize the argument Spherical object with the position coordinate.

Parameters:
timeValue - the time instant for calculating the object's position
spherical - the object to initialize with the object's position coordinate

getCoordinate

public void getCoordinate(double timeValue,
                          Cartesian cartesian)
Calculate the position of the object referenced to it's parent reference frame at the specified time and initialize the argument Cartesian object with the position coordinate.

Parameters:
timeValue - the time instant for calculating the object's position
cartesian - the object to initialize with the object's position coordinate

Jeospace API

Copyright © 2006 - jeospace.org