org.orekit.files.ccsds

Class ADMMetaData

java.lang.Object

org.orekit.files.ccsds.ADMMetaData

public class ADMMetaData
extends Object

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(ADMFile admFile) Create a new meta-data.

Method Summary

Modifier and Type	Method and Description
ADMFile	getADMFile() Get the ADM file to which these meta-data belong.
CelestialBody	getCenterBody() Get the CelestialBody corresponding to the center name.
String	getCenterName() Get the origin of reference frame.
List<String>	getComment() Get the meta-data comment.
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.
TimeScale	getTimeScale() Get the time scale.
CcsdsTimeScale	getTimeSystem() Get the Time System.
void	setCenterBody(CelestialBody centerBody) Set the CelestialBody corresponding to the center name.
void	setCenterName(String centerName) Set the origin of reference frame.
void	setComment(List<String> comment) Set the meta-data comment.
void	setHasCreatableBody(boolean hasCreatableBody) Set boolean testing whether the body corresponding to the centerName attribute can be created through the CelestialBodies.
void	setLaunchNumber(int launchNumber) Set the launch number.
void	setLaunchPiece(String launchPiece) Set the piece of launch.
void	setLaunchYear(int launchYear) Set the launch year.
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	setTimeSystem(CcsdsTimeScale timeSystem) Set the Time System.

Methods inherited from class java.lang.Object

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

Constructor Detail

ADMMetaData

public ADMMetaData(ADMFile admFile)

Create a new meta-data.

Parameters:

admFile - ADM file to which these meta-data belong

Method Detail

getADMFile

public ADMFile getADMFile()

Get the ADM file to which these meta-data belong.

Returns:

ADM file to which these meta-data belong

getTimeSystem

public CcsdsTimeScale getTimeSystem()

Get the Time System.

Returns:

the time system

setTimeSystem

public void setTimeSystem(CcsdsTimeScale timeSystem)

Set the Time System.

Parameters:

timeSystem - the time system to be set

getTimeScale

public TimeScale getTimeScale()

Get the time scale.

Returns:

the time scale.

See Also:

getTimeSystem()

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

setLaunchYear

public void setLaunchYear(int launchYear)

Set the launch year.

Parameters:

launchYear - launch year

getLaunchNumber

public int getLaunchNumber()

Get the launch number.

Returns:

launch number

setLaunchNumber

public void setLaunchNumber(int launchNumber)

Set the launch number.

Parameters:

launchNumber - launch number

getLaunchPiece

public String getLaunchPiece()

Get the piece of launch.

Returns:

piece of launch

setLaunchPiece

public void setLaunchPiece(String launchPiece)

Set the piece of launch.

Parameters:

launchPiece - piece of launch

getCenterName

public String getCenterName()

Get the origin of reference frame.

Returns:

the origin of reference frame.

setCenterName

public void setCenterName(String centerName)

Set the origin of reference frame.

Parameters:

centerName - the origin of reference frame to be set

getCenterBody

public CelestialBody getCenterBody()

Get the CelestialBody corresponding to the center name.

Returns:

the center body

setCenterBody

public void setCenterBody(CelestialBody centerBody)

Set the CelestialBody corresponding to the center name.

Parameters:

centerBody - the CelestialBody to be set

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

setHasCreatableBody

public void setHasCreatableBody(boolean hasCreatableBody)

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

Parameters:

hasCreatableBody - the boolean to be set.

getComment

public List<String> getComment()

Get the meta-data comment.

Returns:

meta-data comment

setComment

public void setComment(List<String> comment)

Set the meta-data comment.

Parameters:

comment - comment to set