CircularParameters (patrius 4.6.1 API)

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

All Implemented Interfaces:

IOrbitalParameters, Serializable
```
public class CircularParameters
extends AbstractOrbitalParameters
```
This class handles circular orbital parameters.
The parameters used internally are the circular elements which can be related to keplerian elements as follows:
- a
- e_x = e cos(ω)
- e_y = e sin(ω)
- i
- Ω
- α_v = v + ω
where Ω stands for the Right Ascension of the Ascending Node and α_v stands for the true latitude argument

The conversion equations from and to keplerian elements given above hold only when both sides are unambiguously defined, i.e. when orbit is neither equatorial nor circular. When orbit is circular (but not equatorial), the circular parameters are still unambiguously defined whereas some keplerian elements (more precisely ω and Ω) become ambiguous. When orbit is equatorial, neither the keplerian nor the circular parameters can be defined unambiguously. equinoctial parameters is the recommended way to represent orbits.
Since:

3.0

Version:

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

Author:

Emmanuel Bignon

See Also:

Serialized Form

Concurrency :

immutable

Constructor Summary

Constructors
Constructor and Description
`CircularParameters(double aIn, double exIn, double eyIn, double iIn, double raanIn, double alpha, PositionAngle type, double mu)` 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`	`getA()` Get the semi-major axis.
`double`	`getAlpha(PositionAngle type)` Get the latitude argument.
`double`	`getAlphaE()` Get the eccentric latitude argument.
`double`	`getAlphaM()` Get the mean latitude argument.
`double`	`getAlphaV()` Get the true latitude argument.
`AlternateEquinoctialParameters`	`getAlternateEquinoctialParameters()` Convert current orbital parameters into alternate equinoctial parameters.
`ApsisAltitudeParameters`	`getApsisAltitudeParameters(double ae)` 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.
`double`	`getCircularEx()` Get the first component of the circular eccentricity vector.
`double`	`getCircularEy()` Get the second component of the circular eccentricity vector.
`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.
`ReentryParameters`	`getReentryParameters(double ae, 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
  - CircularParameters
```
public CircularParameters(double aIn,
                          double exIn,
                          double eyIn,
                          double iIn,
                          double raanIn,
                          double alpha,
                          PositionAngle type,
                          double mu)
```
    Creates a new instance.
    
    Parameters:
    
    aIn - semi-major axis (m)
    
    exIn - e cos(ω), first component of circular eccentricity vector
    
    eyIn - e sin(ω), second component of circular eccentricity vector
    
    iIn - inclination (rad)
    
    raanIn - right ascension of ascending node (Ω, rad)
    
    alpha - an + ω, mean, eccentric or true latitude argument (rad)
    
    type - type of latitude argument
    
    mu - central attraction coefficient (m³/s²)
    
    Throws:
    
    IllegalArgumentException - if eccentricity is equal to 1 or larger
- Method Detail
  - getA
```
public double getA()
```
    Get the semi-major axis.
    
    Returns:
    
    semi-major axis (m)
  - getCircularEx
```
public double getCircularEx()
```
    Get the first component of the circular eccentricity vector.
    
    Returns:
    
    ex = e cos(ω), first component of the circular eccentricity vector
  - getCircularEy
```
public double getCircularEy()
```
    Get the second component of the circular eccentricity vector.
    
    Returns:
    
    ey = e sin(ω), second component of the circular eccentricity vector
  - getI
```
public double getI()
```
    Get the inclination.
    
    Returns:
    
    inclination (rad)
  - getRightAscensionOfAscendingNode
```
public double getRightAscensionOfAscendingNode()
```
    Get the right ascension of the ascending node.
    
    Returns:
    
    right ascension of the ascending node (rad)
  - getAlpha
```
public double getAlpha(PositionAngle type)
```
    Get the latitude argument.
    
    Parameters:
    
    type - type of the angle
    
    Returns:
    
    latitude argument (rad)
  - getAlphaV
```
public double getAlphaV()
```
    Get the true latitude argument.
    
    Returns:
    
    v + ω true latitude argument (rad)
  - getAlphaE
```
public double getAlphaE()
```
    Get the eccentric latitude argument.
    
    Returns:
    
    E + ω eccentric latitude argument (rad)
  - getAlphaM
```
public double getAlphaM()
```
    Get the mean latitude argument.
    
    Returns:
    
    M + ω mean latitude argument (rad)
  - 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 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
  - 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 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
  - 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 CircularParameters

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

CircularParameters

Method Detail

getA

getCircularEx

getCircularEy

getI

getRightAscensionOfAscendingNode

getAlpha

getAlphaV

getAlphaE

getAlphaM

getCartesianParameters

getKeplerianParameters

getCircularParameters

getEquatorialParameters

getEquinoctialParameters

getApsisAltitudeParameters

getApsisRadiusParameters

getReentryParameters

getStelaEquinoctialParameters

getAlternateEquinoctialParameters

toString

equals

hashCode