ApsisAltitudeParameters (patrimoine de base SIRIUS 4.13 API)

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

All Implemented Interfaces:

IOrbitalParameters, Serializable
```
public class ApsisAltitudeParameters
extends AbstractOrbitalParameters
```
This class handles periapsis altitude/apoapsis altitude parameters.
The parameters used internally are the apsis elements which can be related to keplerian elements as follows:
- periapsis altitude = a (1 - e) - req
- apoapsis altitude = a (1 + e) - req
- i
- ω
- Ω
- v
where Ω stands for the Right Ascension of the Ascending Node, v stands for true anomaly and req for central body radius (m)
Since:

3.0

Version:

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

Author:

Emmanuel Bignon

See Also:

Serialized Form

Concurrency :

immutable

Constructor Summary

Constructors
Constructor and Description
`ApsisAltitudeParameters(double periapsisAltitudeIn, double apoapsisAltitudeIn, double i, double pa, double raan, double anomaly, PositionAngle type, double mu, double aeIn)` Creates a new instance.

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.
`double`	`getAe()` Getter for equatorial radius.
`AlternateEquinoctialParameters`	`getAlternateEquinoctialParameters()` Convert current orbital parameters into alternate equinoctial parameters.
`double`	`getAnomaly(PositionAngle type)` Get the anomaly.
`double`	`getApoapsisAltitude()` Get the apoapsis altitude.
`ApsisAltitudeParameters`	`getApsisAltitudeParameters(double req)` Convert current orbital parameters into apsis (using altitude) parameters.
`ApsisRadiusParameters`	`getApsisRadiusParameters()` 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.
`EquatorialParameters`	`getEquatorialParameters()` Convert current orbital parameters into equatorial parameters.
`EquinoctialParameters`	`getEquinoctialParameters()` Convert current orbital parameters into equinoctial parameters.
`double`	`getI()` Get the inclination.
`KeplerianParameters`	`getKeplerianParameters()` Convert current orbital parameters into Keplerian parameters.
`double`	`getPeriapsisAltitude()` Get the periapsis altitude.
`double`	`getPerigeeArgument()` Get the perigee argument.
`ReentryParameters`	`getReentryParameters(double req, double f)` Convert current orbital parameters into reentry parameters.
`double`	`getRightAscensionOfAscendingNode()` Get the right ascension of the ascending node.
`StelaEquinoctialParameters`	`getStelaEquinoctialParameters()` Convert current orbital parameters into Stela equinoctial parameters.
`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
  - ApsisAltitudeParameters
```
public ApsisAltitudeParameters(double periapsisAltitudeIn,
                               double apoapsisAltitudeIn,
                               double i,
                               double pa,
                               double raan,
                               double anomaly,
                               PositionAngle type,
                               double mu,
                               double aeIn)
```
    Creates a new instance.
    
    Parameters:
    
    periapsisAltitudeIn - periapsis altitude (m)
    
    apoapsisAltitudeIn - apoapsis altitude (m)
    
    i - inclination (rad)
    
    pa - perigee argument (ω, rad)
    
    raan - right ascension of ascending node (Ω, rad)
    
    anomaly - mean, eccentric or true anomaly (rad).
    
    type - type of anomaly
    
    mu - central attraction coefficient (m³/s²)
    
    aeIn - central body equatorial radius (m)
- Method Detail
  - getPeriapsisAltitude
```
public double getPeriapsisAltitude()
```
    Get the periapsis altitude.
    
    Returns:
    
    periapsis altitude (m)
  - getApoapsisAltitude
```
public double getApoapsisAltitude()
```
    Get the apoapsis altitude.
    
    Returns:
    
    apoapsis altitude (m)
  - getI
```
public double getI()
```
    Get the inclination.
    
    Returns:
    
    inclination (rad)
  - getPerigeeArgument
```
public double getPerigeeArgument()
```
    Get the perigee argument.
    
    Returns:
    
    perigee argument (rad)
  - getRightAscensionOfAscendingNode
```
public double getRightAscensionOfAscendingNode()
```
    Get the right ascension of the ascending node.
    
    Returns:
    
    right ascension of the ascending node (rad)
  - getAnomaly
```
public double getAnomaly(PositionAngle type)
```
    Get the anomaly.
    
    Parameters:
    
    type - type of the angle
    
    Returns:
    
    anomaly (rad)
  - getAe
```
public double getAe()
```
    Getter for equatorial radius.
    
    Returns:
    
    equatorial radius (m)
  - 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
  - getCircularParameters
```
public CircularParameters getCircularParameters()
```
    Convert current orbital parameters into circular parameters.
    
    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
  - getEquinoctialParameters
```
public EquinoctialParameters getEquinoctialParameters()
```
    Convert current orbital parameters into equinoctial parameters.
    
    Returns:
    
    current orbital parameters converted into equinoctial parameters
    
    See Also:
    
    EquinoctialParameters
  - getApsisAltitudeParameters
```
public ApsisAltitudeParameters getApsisAltitudeParameters(double req)
```
    Convert current orbital parameters into apsis (using altitude) parameters.
    
    Parameters:
    
    req - equatorial radius (m)
    
    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
  - getReentryParameters
```
public ReentryParameters getReentryParameters(double req,
                                              double f)
```
    Convert current orbital parameters into reentry parameters.
    
    Parameters:
    
    req - equatorial radius (m)
    
    f - flattening (f = (a-b)/a)
    
    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
  - 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 ApsisAltitudeParameters

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ApsisAltitudeParameters

Method Detail

getPeriapsisAltitude

getApoapsisAltitude

getI

getPerigeeArgument

getRightAscensionOfAscendingNode

getAnomaly

getAe

getCartesianParameters

getKeplerianParameters

getCircularParameters

getEquatorialParameters

getEquinoctialParameters

getApsisAltitudeParameters

getApsisRadiusParameters

getReentryParameters

getStelaEquinoctialParameters

getAlternateEquinoctialParameters

toString

equals

hashCode