org.orekit.files.ccsds.ndm.adm.apm

Class SpinStabilized

java.lang.Object

org.orekit.files.ccsds.section.CommentsContainer

org.orekit.files.ccsds.ndm.adm.apm.SpinStabilized

All Implemented Interfaces:

Section

public class SpinStabilized
extends CommentsContainer

Container for Attitude Parameter Message data lines.

Since:

10.2

Author:

Bryan Cazabonne

Constructor Summary

Constructors

Constructor and Description
SpinStabilized() Simple constructor.

Method Summary

Modifier and Type	Method and Description
AttitudeEndpoints	getEndpoints() Get the endpoints (i.e.
double	getMomentumAlpha() Get the right ascension of angular momentum vector (rad).
double	getMomentumDelta() Get the declination of the angular momentum vector (rad).
double	getNutation() Get the nutation angle of spin axis (rad).
double	getNutationPeriod() Get the body nutation period of the spin axis (s).
double	getNutationPhase() Get the inertial nutation phase (rad).
double	getNutationVel() Get the angular velocity of spin vector around angular momentum vector.
double	getSpinAlpha() Get the right ascension of spin axis vector (rad).
double	getSpinAngle() Get the phase of the satellite about the spin axis (rad).
double	getSpinAngleVel() Get the angular velocity of satellite around spin axis (rad/s).
double	getSpinDelta() Get the declination of the spin axis vector (rad).
boolean	hasMomentum() Check if the logical block includes momentum.
boolean	hasNutation() Check if the logical block includes nutation.
void	setMomentumAlpha(double momentumAlpha) Set the right ascension of angular momentum vector (rad).
void	setMomentumDelta(double momentumDelta) Set the declination of the angular momentum vector (rad).
void	setNutation(double nutation) Set the nutation angle of spin axis (rad).
void	setNutationPeriod(double period) Set the body nutation period of the spin axis (s).
void	setNutationPhase(double nutationPhase) Set the inertial nutation phase (rad).
void	setNutationVel(double nutationVel) Set the angular velocity of spin vector around angular momentum vector.
void	setSpinAlpha(double spinAlpha) Set the right ascension of spin axis vector (rad).
void	setSpinAngle(double spinAngle) Set the phase of the satellite about the spin axis (rad).
void	setSpinAngleVel(double spinAngleVel) Set the angular velocity of satellite around spin axis (rad/s).
void	setSpinDelta(double spinDelta) Set the declination of the spin axis vector (rad).
void	validate(double version) Check is all mandatory entries have been initialized.

Methods inherited from class org.orekit.files.ccsds.section.CommentsContainer

acceptComments, addComment, checkAllowed, checkNotNaN, checkNotNegative, checkNotNull, getComments, refuseFurtherComments

Methods inherited from class java.lang.Object

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

Constructor Detail

SpinStabilized

public SpinStabilized()

Simple constructor.

Method Detail

validate

public void validate(double version)

Check is all mandatory entries have been initialized.

This method should throw an exception if some mandatory entries are missing or not compatible with version number.

Specified by:

validate in interface Section

Overrides:

validate in class CommentsContainer

Parameters:

version - format version

getEndpoints

public AttitudeEndpoints getEndpoints()

Get the endpoints (i.e. frames A, B and their relationship).

Returns:

endpoints

getSpinAlpha

public double getSpinAlpha()

Get the right ascension of spin axis vector (rad).

Returns:

the right ascension of spin axis vector

setSpinAlpha

public void setSpinAlpha(double spinAlpha)

Set the right ascension of spin axis vector (rad).

Parameters:

spinAlpha - value to be set

getSpinDelta

public double getSpinDelta()

Get the declination of the spin axis vector (rad).

Returns:

the declination of the spin axis vector (rad).

setSpinDelta

public void setSpinDelta(double spinDelta)

Set the declination of the spin axis vector (rad).

Parameters:

spinDelta - value to be set

getSpinAngle

public double getSpinAngle()

Get the phase of the satellite about the spin axis (rad).

Returns:

the phase of the satellite about the spin axis

setSpinAngle

public void setSpinAngle(double spinAngle)

Set the phase of the satellite about the spin axis (rad).

Parameters:

spinAngle - value to be set

getSpinAngleVel

public double getSpinAngleVel()

Get the angular velocity of satellite around spin axis (rad/s).

Returns:

the angular velocity of satellite around spin axis

setSpinAngleVel

public void setSpinAngleVel(double spinAngleVel)

Set the angular velocity of satellite around spin axis (rad/s).

Parameters:

spinAngleVel - value to be set

getNutation

public double getNutation()

Get the nutation angle of spin axis (rad).

Returns:

the nutation angle of spin axis

setNutation

public void setNutation(double nutation)

Set the nutation angle of spin axis (rad).

Parameters:

nutation - the nutation angle to be set

getNutationPeriod

public double getNutationPeriod()

Get the body nutation period of the spin axis (s).

Returns:

the body nutation period of the spin axis

setNutationPeriod

public void setNutationPeriod(double period)

Set the body nutation period of the spin axis (s).

Parameters:

period - the nutation period to be set

getNutationPhase

public double getNutationPhase()

Get the inertial nutation phase (rad).

Returns:

the inertial nutation phase

setNutationPhase

public void setNutationPhase(double nutationPhase)

Set the inertial nutation phase (rad).

Parameters:

nutationPhase - the nutation phase to be set

getMomentumAlpha

public double getMomentumAlpha()

Get the right ascension of angular momentum vector (rad).

Returns:

the right ascension of angular momentum vector

Since:

12.0

setMomentumAlpha

public void setMomentumAlpha(double momentumAlpha)

Set the right ascension of angular momentum vector (rad).

Parameters:

momentumAlpha - value to be set

Since:

12.0

getMomentumDelta

public double getMomentumDelta()

Get the declination of the angular momentum vector (rad).

Returns:

the declination of the angular momentum vector (rad).

Since:

12.0

setMomentumDelta

public void setMomentumDelta(double momentumDelta)

Set the declination of the angular momentum vector (rad).

Parameters:

momentumDelta - value to be set

Since:

12.0

getNutationVel

public double getNutationVel()

Get the angular velocity of spin vector around angular momentum vector.

Returns:

angular velocity of spin vector around angular momentum vector (rad/s)

Since:

12.0

setNutationVel

public void setNutationVel(double nutationVel)

Set the angular velocity of spin vector around angular momentum vector.

Parameters:

nutationVel - angular velocity of spin vector around angular momentum vector (rad/s)

Since:

12.0

hasNutation

public boolean hasNutation()

Check if the logical block includes nutation.

Returns:

true if logical block includes nutation

Since:

12.0

hasMomentum

public boolean hasMomentum()

Check if the logical block includes momentum.

Returns:

true if logical block includes momentum

Since:

12.0