fr.cnes.sirius.patrius.propagation.numerical

Class AttitudeEquation

java.lang.Object

fr.cnes.sirius.patrius.propagation.numerical.AttitudeEquation

All Implemented Interfaces:

AdditionalEquations, Externalizable, Serializable

public abstract class AttitudeEquation
extends Object
implements AdditionalEquations

This interface allows users to add their own attitude differential equations to a numerical propagator.

Since:

2.3

Version:

$Id: AttitudeEquation.java 18084 2017-10-02 16:55:24Z bignon $

Author:

Charlotte Maggiorani

See Also:

AdditionalEquations, Serialized Form

Concurrency :

not thread-safe

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AttitudeEquation.AttitudeType Attitude type.

Constructor Summary

Constructors

Constructor and Description
AttitudeEquation(AttitudeEquation.AttitudeType attitudeType) Create a new attitude equation.

Method Summary

Modifier and Type	Method and Description
AttitudeEquation.AttitudeType	getAttitudeType() Get the attitude type.
String	getName() Get the name of the additional equation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface fr.cnes.sirius.patrius.propagation.numerical.AdditionalEquations

buildAdditionalState, computeDerivatives, computeSecondDerivatives, extractY, extractYDot, getFirstOrderDimension, getSecondOrderDimension

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Constructor Detail

AttitudeEquation

public AttitudeEquation(AttitudeEquation.AttitudeType attitudeType)

Create a new attitude equation. The name of the created equation is set by default in the following form "ATTITUDE_FORCES" or "ATTITUDE_EVENTS" or "ATTITUDE"

Parameters:

attitudeType - the attitude type

Method Detail

getName

public String getName()

Get the name of the additional equation. The name is in the following form : "ATTITUDE_FORCES" or "ATTITUDE_EVENTS" or "ATTITUDE".

Specified by:

getName in interface AdditionalEquations

Returns:

name of the additional equation

getAttitudeType

public AttitudeEquation.AttitudeType getAttitudeType()

Get the attitude type.

Returns:

the attitude type : ATTITUDE_FORCES or ATTITUDE_EVENTS or ATTITUDE