org.orekit.files.ccsds.ndm.adm

Class AdmMetadata

java.lang.Object

org.orekit.files.ccsds.section.CommentsContainer

org.orekit.files.ccsds.section.Metadata

org.orekit.files.ccsds.ndm.adm.AdmMetadata

All Implemented Interfaces:

Section

Direct Known Subclasses:

AemMetadata

public class AdmMetadata
extends Metadata

This class gathers the meta-data present in the Attitude Data Message (ADM).

Since:

10.2

Author:

Bryan Cazabonne

Constructor Summary

Constructors

Constructor and Description
AdmMetadata() Simple constructor.

Method Summary

Modifier and Type	Method and Description
BodyFacade	getCenter() Get the body at origin of reference frame.
boolean	getHasCreatableBody() Get boolean testing whether the body corresponding to the centerName attribute can be created through the CelestialBodies.
int	getLaunchNumber() Get the launch number.
String	getLaunchPiece() Get the piece of launch.
int	getLaunchYear() Get the launch year.
String	getObjectID() Get the spacecraft ID for which the attitude data are provided.
String	getObjectName() Get the spacecraft name for which the attitude data are provided.
void	setCenter(BodyFacade center) Set the body at origin of reference frame.
void	setObjectID(String objectID) Set the spacecraft ID for which the attitude data are provided.
void	setObjectName(String objectName) Set the spacecraft name for which the attitude data are provided.
void	validate(double version) Check is all mandatory entries have been initialized.

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

getLaunchNumber, getLaunchPiece, getLaunchYear, getTimeSystem, setTimeSystem

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

AdmMetadata

public AdmMetadata()

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 Metadata

Parameters:

version - format version

getObjectName

public String getObjectName()

Get the spacecraft name for which the attitude data are provided.

Returns:

the spacecraft name

setObjectName

public void setObjectName(String objectName)

Set the spacecraft name for which the attitude data are provided.

Parameters:

objectName - the spacecraft name to be set

getObjectID

public String getObjectID()

Get the spacecraft ID for which the attitude data are provided.

Returns:

the spacecraft ID

setObjectID

public void setObjectID(String objectID)

Set the spacecraft ID for which the attitude data are provided.

Parameters:

objectID - the spacecraft ID to be set

getLaunchYear

public int getLaunchYear()

Get the launch year.

Returns:

launch year

getLaunchNumber

public int getLaunchNumber()

Get the launch number.

Returns:

launch number

getLaunchPiece

public String getLaunchPiece()

Get the piece of launch.

Returns:

piece of launch

getCenter

public BodyFacade getCenter()

Get the body at origin of reference frame.

Returns:

the body at origin of reference frame.

setCenter

public void setCenter(BodyFacade center)

Set the body at origin of reference frame.

Parameters:

center - body at origin of reference frame

getHasCreatableBody

public boolean getHasCreatableBody()

Get boolean testing whether the body corresponding to the centerName attribute can be created through the CelestialBodies.

Returns:

true if CelestialBody can be created from centerName false otherwise