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

Class ApmData

java.lang.Object

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

All Implemented Interfaces:

Data, Section

public class ApmData
extends Object
implements Data

Container for Attitude Parameter Message data.

Since:

10.2

Author:

Bryan Cazabonne

Constructor Summary

Constructors

Constructor and Description
ApmData(CommentsContainer commentsBlock, ApmQuaternion quaternionBlock, Euler eulerBlock, SpinStabilized spinStabilizedBlock, SpacecraftParameters spacecraftParameters) Simple constructor.

Method Summary

Modifier and Type	Method and Description
void	addManeuver(Maneuver maneuver) Add a maneuver.
List<String>	getComments() Get the comments.
Euler	getEulerBlock() Get the Euler angles logical block.
Maneuver	getManeuver(int index) Get a maneuver.
List<Maneuver>	getManeuvers() Get a list of all maneuvers.
int	getNbManeuvers() Get the number of maneuvers present in the APM.
ApmQuaternion	getQuaternionBlock() Get the quaternion logical block.
SpacecraftParameters	getSpacecraftParametersBlock() Get the spacecraft parameters logical block.
SpinStabilized	getSpinStabilizedBlock() Get the spin-stabilized logical block.
boolean	hasManeuvers() Get boolean testing whether the APM contains at least one maneuver.
void	validate(double version) Check is all mandatory entries have been initialized.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApmData

public ApmData(CommentsContainer commentsBlock,
               ApmQuaternion quaternionBlock,
               Euler eulerBlock,
               SpinStabilized spinStabilizedBlock,
               SpacecraftParameters spacecraftParameters)

Simple constructor.

Parameters:

commentsBlock - general comments block

quaternionBlock - quaternion logical block

eulerBlock - Euler angles logicial block (may be null)

spinStabilizedBlock - spin-stabilized logical block (may be null)

spacecraftParameters - spacecraft parameters logical block (may be null)

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

Parameters:

version - format version

getComments

public List<String> getComments()

Get the comments.

Returns:

comments

getQuaternionBlock

public ApmQuaternion getQuaternionBlock()

Get the quaternion logical block.

Returns:

quaternion block

getEulerBlock

public Euler getEulerBlock()

Get the Euler angles logical block.

Returns:

Euler angles block (may be null)

getSpinStabilizedBlock

public SpinStabilized getSpinStabilizedBlock()

Get the spin-stabilized logical block.

Returns:

spin-stabilized block (may be null)

getSpacecraftParametersBlock

public SpacecraftParameters getSpacecraftParametersBlock()

Get the spacecraft parameters logical block.

Returns:

spacecraft parameters block (may be null)

getNbManeuvers

public int getNbManeuvers()

Get the number of maneuvers present in the APM.

Returns:

the number of maneuvers

getManeuvers

public List<Maneuver> getManeuvers()

Get a list of all maneuvers.

Returns:

unmodifiable list of all maneuvers.

getManeuver

public Maneuver getManeuver(int index)

Get a maneuver.

Parameters:

index - maneuver index, counting from 0

Returns:

maneuver

addManeuver

public void addManeuver(Maneuver maneuver)

Add a maneuver.

Parameters:

maneuver - maneuver to be set

hasManeuvers

public boolean hasManeuvers()

Get boolean testing whether the APM contains at least one maneuver.

Returns:

true if APM contains at least one maneuver false otherwise