CartesianParameters (patrius 4.5.1 API)

java.lang.Object
- fr.cnes.sirius.patrius.orbits.orbitalparameters.AbstractOrbitalParameters
- - fr.cnes.sirius.patrius.orbits.orbitalparameters.CartesianParameters

All Implemented Interfaces:

IOrbitalParameters, Serializable
```
public class CartesianParameters
extends AbstractOrbitalParameters
```
This class holds cartesian orbital parameters.
The parameters used internally are the cartesian coordinates:
- x
- y
- z
- xDot
- yDot
- zDot
contained in PVCoordinates.
Since:

3.0

Version:

$Id: CartesianParameters.java 18071 2017-10-02 16:46:39Z bignon $

Author:

Emmanuel Bignon

See Also:

Serialized Form

Concurrency :

immutable

Constructor Summary

Constructors
Constructor and Description
`CartesianParameters(PVCoordinates pvCoordinatesIn, double mu)` Constructor with PV coordinates.
`CartesianParameters(Vector3D position, Vector3D velocity, Vector3D acceleration, double mu)` Constructor with position and velocity.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object object)` Test for the equality of two orbits.
`AlternateEquinoctialParameters`	`getAlternateEquinoctialParameters()` Convert current orbital parameters into alternate equinoctial parameters.
`ApsisAltitudeParameters`	`getApsisAltitudeParameters(double ae)` Convert current orbital parameters into apsis (using altitude) parameters.
`ApsisAltitudeParameters`	`getApsisAltitudeParameters(double ae, double mu)` Convert current orbital parameters into apsis (using altitude) parameters.
`ApsisRadiusParameters`	`getApsisRadiusParameters()` Convert current orbital parameters into apsis (using radius) parameters.
`ApsisRadiusParameters`	`getApsisRadiusParameters(double mu)` Convert current orbital parameters into apsis (using radius) parameters.
`CartesianParameters`	`getCartesianParameters()` Convert current orbital parameters into cartesian parameters.
`CircularParameters`	`getCircularParameters()` Convert current orbital parameters into circular parameters.
`CircularParameters`	`getCircularParameters(double mu)` Convert current orbital parameters into circular parameters.
`EquatorialParameters`	`getEquatorialParameters()` Convert current orbital parameters into equatorial parameters.
`EquatorialParameters`	`getEquatorialParameters(double mu)` Convert current orbital parameters into equatorial parameters.
`EquinoctialParameters`	`getEquinoctialParameters()` Convert current orbital parameters into equinoctial parameters.
`EquinoctialParameters`	`getEquinoctialParameters(double mu)` Convert current orbital parameters into equinoctial parameters.
`KeplerianParameters`	`getKeplerianParameters()` Convert current orbital parameters into Keplerian parameters.
`KeplerianParameters`	`getKeplerianParameters(double mu)` Convert current orbital parameters into circular parameters.
`Vector3D`	`getPosition()` Get the position.
`PVCoordinates`	`getPVCoordinates()` Get the PV coordinates.
`ReentryParameters`	`getReentryParameters(double ae, double f)` Convert current orbital parameters into reentry parameters.
`ReentryParameters`	`getReentryParameters(double ae, double f, double mu)` Convert current orbital parameters into reentry parameters.
`StelaEquinoctialParameters`	`getStelaEquinoctialParameters()` Convert current orbital parameters into Stela equinoctial parameters.
`StelaEquinoctialParameters`	`getStelaEquinoctialParameters(double mu)` Convert current orbital parameters into Stela equinoctial parameters.
`Vector3D`	`getVelocity()` Get the velocity.
`int`	`hashCode()` Get a hashCode for the orbit.
`String`	`toString()` Returns a string representation of this Orbit object.

Methods inherited from class fr.cnes.sirius.patrius.orbits.orbitalparameters.AbstractOrbitalParameters
getMu

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CartesianParameters
```
public CartesianParameters(PVCoordinates pvCoordinatesIn,
                           double mu)
```
    Constructor with PV coordinates.
    
    Parameters:
    
    pvCoordinatesIn - position and velocity
    
    mu - central attraction coefficient (m³/s²)
  - CartesianParameters
```
public CartesianParameters(Vector3D position,
                           Vector3D velocity,
                           Vector3D acceleration,
                           double mu)
```
    Constructor with position and velocity.
    
    Parameters:
    
    position - position
    
    velocity - velocity
    
    acceleration - acceleration
    
    mu - central attraction coefficient (m³/s²)
- Method Detail
  - getPVCoordinates
```
public PVCoordinates getPVCoordinates()
```
    Get the PV coordinates.
    
    Returns:
    
    pvCoordinates
  - getPosition
```
public Vector3D getPosition()
```
    Get the position.
    
    Returns:
    
    position
  - getVelocity
```
public Vector3D getVelocity()
```
    Get the velocity.
    
    Returns:
    
    velocity
  - getCartesianParameters
```
public CartesianParameters getCartesianParameters()
```
    Convert current orbital parameters into cartesian parameters.
    
    Returns:
    
    current orbital parameters converted into cartesian parameters
    
    See Also:
    
    CartesianParameters
  - getKeplerianParameters
```
public KeplerianParameters getKeplerianParameters()
```
    Convert current orbital parameters into Keplerian parameters.
    
    Returns:
    
    current orbital parameters converted into Keplerian parameters
    
    See Also:
    
    KeplerianParameters
  - getKeplerianParameters
```
public KeplerianParameters getKeplerianParameters(double mu)
```
    Convert current orbital parameters into circular parameters.
    
    Parameters:
    
    mu - central attraction coefficient (m³/s²)
    
    Returns:
    
    current orbital parameters converted into circular parameters
    
    See Also:
    
    CircularParameters
  - getCircularParameters
```
public CircularParameters getCircularParameters()
```
    Convert current orbital parameters into circular parameters.
    
    Returns:
    
    current orbital parameters converted into circular parameters
    
    See Also:
    
    CircularParameters
  - getCircularParameters
```
public CircularParameters getCircularParameters(double mu)
```
    Convert current orbital parameters into circular parameters.
    
    Parameters:
    
    mu - central attraction coefficient (m³/s²)
    
    Returns:
    
    current orbital parameters converted into circular parameters
    
    See Also:
    
    CircularParameters
  - getEquatorialParameters
```
public EquatorialParameters getEquatorialParameters()
```
    Convert current orbital parameters into equatorial parameters.
    
    Returns:
    
    current orbital parameters converted into equatorial parameters
    
    See Also:
    
    EquatorialParameters
  - getEquatorialParameters
```
public EquatorialParameters getEquatorialParameters(double mu)
```
    Convert current orbital parameters into equatorial parameters.
    
    Parameters:
    
    mu - central attraction coefficient (m³/s²)
    
    Returns:
    
    current orbital parameters converted into equatorial parameters
    
    See Also:
    
    EquatorialParameters
  - getEquinoctialParameters
```
public EquinoctialParameters getEquinoctialParameters()
```
    Convert current orbital parameters into equinoctial parameters.
    
    Returns:
    
    current orbital parameters converted into equinoctial parameters
    
    See Also:
    
    EquinoctialParameters
  - getEquinoctialParameters
```
public EquinoctialParameters getEquinoctialParameters(double mu)
```
    Convert current orbital parameters into equinoctial parameters.
    
    Parameters:
    
    mu - central attraction coefficient (m³/s²)
    
    Returns:
    
    current orbital parameters converted into equinoctial parameters
    
    See Also:
    
    EquinoctialParameters
  - getApsisAltitudeParameters
```
public ApsisAltitudeParameters getApsisAltitudeParameters(double ae)
```
    Convert current orbital parameters into apsis (using altitude) parameters.
    
    Parameters:
    
    ae - equatorial radius (m)
    
    Returns:
    
    current orbital parameters converted into apsis (using altitude) parameters
    
    See Also:
    
    ApsisAltitudeParameters
  - getApsisAltitudeParameters
```
public ApsisAltitudeParameters getApsisAltitudeParameters(double ae,
                                                          double mu)
```
    Convert current orbital parameters into apsis (using altitude) parameters.
    
    Parameters:
    
    ae - equatorial radius (m)
    
    mu - central attraction coefficient (m³/s²)
    
    Returns:
    
    current orbital parameters converted into apsis (using altitude) parameters
    
    See Also:
    
    ApsisAltitudeParameters
  - getApsisRadiusParameters
```
public ApsisRadiusParameters getApsisRadiusParameters()
```
    Convert current orbital parameters into apsis (using radius) parameters.
    
    Returns:
    
    current orbital parameters converted into apsis (using radius) parameters
    
    See Also:
    
    ApsisRadiusParameters
  - getApsisRadiusParameters
```
public ApsisRadiusParameters getApsisRadiusParameters(double mu)
```
    Convert current orbital parameters into apsis (using radius) parameters.
    
    Parameters:
    
    mu - central attraction coefficient (m³/s²)
    
    Returns:
    
    current orbital parameters converted into apsis (using radius) parameters
    
    See Also:
    
    ApsisRadiusParameters
  - getReentryParameters
```
public ReentryParameters getReentryParameters(double ae,
                                              double f)
```
    Convert current orbital parameters into reentry parameters.
    
    Parameters:
    
    ae - equatorial radius (m)
    
    f - flattening (f = (a-b)/a)
    
    Returns:
    
    current orbital parameters converted into reentry parameters
    
    See Also:
    
    ReentryParameters
  - getReentryParameters
```
public ReentryParameters getReentryParameters(double ae,
                                              double f,
                                              double mu)
```
    Convert current orbital parameters into reentry parameters.
    
    Parameters:
    
    ae - equatorial radius (m)
    
    f - flattening (f = (a-b)/a)
    
    mu - central attraction coefficient (m³/s²)
    
    Returns:
    
    current orbital parameters converted into reentry parameters
    
    See Also:
    
    ReentryParameters
  - getStelaEquinoctialParameters
```
public StelaEquinoctialParameters getStelaEquinoctialParameters()
```
    Convert current orbital parameters into Stela equinoctial parameters.
    
    Returns:
    
    current orbital parameters converted into Stela equinoctial parameters
    
    See Also:
    
    StelaEquinoctialParameters
  - getStelaEquinoctialParameters
```
public StelaEquinoctialParameters getStelaEquinoctialParameters(double mu)
```
    Convert current orbital parameters into Stela equinoctial parameters.
    
    Parameters:
    
    mu - central attraction coefficient (m³/s²)
    
    Returns:
    
    current orbital parameters converted into Stela equinoctial parameters
    
    See Also:
    
    StelaEquinoctialParameters
  - getAlternateEquinoctialParameters
```
public AlternateEquinoctialParameters getAlternateEquinoctialParameters()
```
    Convert current orbital parameters into alternate equinoctial parameters.
    
    Returns:
    
    current orbital parameters converted into alternate equinoctial parameters
    
    See Also:
    
    AlternateEquinoctialParameters
  - toString
```
public String toString()
```
    Returns a string representation of this Orbit object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of this object
  - equals
```
public boolean equals(Object object)
```
    Test for the equality of two orbits.
    Orbits are considered equals if they have the same type and all their attributes are equals. In particular, the orbits frame are considered equals if they represent the same instance. If they have the same attributes but are not the same instance, the method will return false.
    
    Specified by:
    
    equals in interface IOrbitalParameters
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    object - Object to test for equality to this
    
    Returns:
    
    true if two orbits are equal
  - hashCode
```
public int hashCode()
```
    Get a hashCode for the orbit.
    
    Specified by:
    
    hashCode in interface IOrbitalParameters
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for this object

Class CartesianParameters

Constructor Summary

Method Summary

Methods inherited from class fr.cnes.sirius.patrius.orbits.orbitalparameters.AbstractOrbitalParameters

Methods inherited from class java.lang.Object

Constructor Detail

CartesianParameters

CartesianParameters

Method Detail

getPVCoordinates

getPosition

getVelocity

getCartesianParameters

getKeplerianParameters

getKeplerianParameters

getCircularParameters

getCircularParameters

getEquatorialParameters

getEquatorialParameters

getEquinoctialParameters

getEquinoctialParameters

getApsisAltitudeParameters

getApsisAltitudeParameters

getApsisRadiusParameters

getApsisRadiusParameters

getReentryParameters

getReentryParameters

getStelaEquinoctialParameters

getStelaEquinoctialParameters

getAlternateEquinoctialParameters

toString

equals

hashCode