org.orekit.files.ccsds

Class ODMMetaData

java.lang.Object

org.orekit.files.ccsds.ODMMetaData

Direct Known Subclasses:

OMMFile.OMMMetaData

public class ODMMetaData
extends Object

This class gathers the meta-data present in the Orbital Data Message (ODM).

Since:

6.1

Author:

sports

Constructor Summary

Constructors

Constructor and Description
ODMMetaData(ODMFile odmFile) Create a new meta-data.

Method Summary

Modifier and Type	Method and Description
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.
Frame	getFrame() Get the reference frame in which data are given: used for state vector and Keplerian elements data (and for the covariance reference frame if none is given).
AbsoluteDate	getFrameEpoch() Get epoch of reference frame, if not intrinsic to the definition of the reference frame.
String	getFrameEpochString() Get epoch of reference frame, if not intrinsic to the definition of the reference frame.
String	getFrameString() Get the reference frame specifier as it appeared in the file.
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 orbit state is provided.
String	getObjectName() Get the spacecraft name for which the orbit state is provided.
ODMFile	getODMFile() Get the ODM file to which these meta-data belong.
Frame	getRefFrame() Get the the value of REF_FRAME as an Orekit Frame.
TimeScale	getTimeScale() Get the time scale.
CcsdsTimeScale	getTimeSystem() Get the Time System that: for OPM, is used for metadata, state vector, maneuver and covariance data, for OMM, is used for metadata, orbit state and covariance data, for OEM, is used for metadata, ephemeris and covariance data.
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	setFrameEpoch(AbsoluteDate frameEpoch) Set epoch of reference frame, if not intrinsic to the definition of the reference frame.
void	setFrameEpochString(String frameEpochString) Set epoch of reference frame, if not intrinsic to the definition of the reference frame.
void	setFrameString(String frame) Set the reference frame name.
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 orbit state is provided.
void	setObjectName(String objectName) Set the spacecraft name for which the orbit state is provided.
void	setRefFrame(Frame refFrame) Set the reference frame in which data are given: used for state vector and Keplerian elements data (and for the covariance reference frame if none is given).
void	setTimeSystem(CcsdsTimeScale timeSystem) Set the Time System that: for OPM, is used for metadata, state vector, maneuver and covariance data, for OMM, is used for metadata, orbit state and covariance data, for OEM, is used for metadata, ephemeris and covariance data.

Methods inherited from class java.lang.Object

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

Constructor Detail

ODMMetaData

public ODMMetaData(ODMFile odmFile)

Create a new meta-data.

Parameters:

odmFile - ODM file to which these meta-data belong

Method Detail

getODMFile

public ODMFile getODMFile()

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

Returns:

ODM file to which these meta-data belong

getTimeSystem

public CcsdsTimeScale getTimeSystem()

Get the Time System that: for OPM, is used for metadata, state vector, maneuver and covariance data, for OMM, is used for metadata, orbit state and covariance data, for OEM, is used for metadata, ephemeris and covariance data.

Returns:

the time system

setTimeSystem

public void setTimeSystem(CcsdsTimeScale timeSystem)

Set the Time System that: for OPM, is used for metadata, state vector, maneuver and covariance data, for OMM, is used for metadata, orbit state and covariance data, for OEM, is used for metadata, ephemeris and covariance data.

Parameters:

timeSystem - the time system to be set

getTimeScale

public TimeScale getTimeScale()

Get the time scale.

Returns:

the time scale.

Throws:

OrekitException - if there is not corresponding time scale.

Since:

10.1

See Also:

getTimeSystem()

getObjectName

public String getObjectName()

Get the spacecraft name for which the orbit state is provided.

Returns:

the spacecraft name

setObjectName

public void setObjectName(String objectName)

Set the spacecraft name for which the orbit state is provided.

Parameters:

objectName - the spacecraft name to be set

getObjectID

public String getObjectID()

Get the spacecraft ID for which the orbit state is provided.

Returns:

the spacecraft ID

setObjectID

public void setObjectID(String objectID)

Set the spacecraft ID for which the orbit state is provided.

Parameters:

objectID - the spacecraft ID to be set

setLaunchYear

public void setLaunchYear(int launchYear)

Set the launch year.

Parameters:

launchYear - launch year

getLaunchYear

public int getLaunchYear()

Get the launch year.

Returns:

launch year

setLaunchNumber

public void setLaunchNumber(int launchNumber)

Set the launch number.

Parameters:

launchNumber - launch number

getLaunchNumber

public int getLaunchNumber()

Get the launch number.

Returns:

launch number

setLaunchPiece

public void setLaunchPiece(String launchPiece)

Set the piece of launch.

Parameters:

launchPiece - piece of launch

getLaunchPiece

public String getLaunchPiece()

Get the piece of launch.

Returns:

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.

getFrame

public Frame getFrame()

Get the reference frame in which data are given: used for state vector and Keplerian elements data (and for the covariance reference frame if none is given).

Returns:

the reference frame

getRefFrame

public Frame getRefFrame()

Get the the value of REF_FRAME as an Orekit Frame. The CENTER_NAME key word has not been applied yet, so the returned frame may not correspond to the reference frame of the data in the file.

Returns:

The reference frame specified by the REF_FRAME keyword.

See Also:

getFrame()

setRefFrame

public void setRefFrame(Frame refFrame)

Set the reference frame in which data are given: used for state vector and Keplerian elements data (and for the covariance reference frame if none is given).

Parameters:

refFrame - the reference frame to be set

getFrameString

public String getFrameString()

Get the reference frame specifier as it appeared in the file.

Returns:

the frame name as it appeared in the file.

See Also:

getFrame()

setFrameString

public void setFrameString(String frame)

Set the reference frame name.

Parameters:

frame - specifier as it appeared in the file.

getFrameEpochString

public String getFrameEpochString()

Get epoch of reference frame, if not intrinsic to the definition of the reference frame.

Returns:

epoch of reference frame

setFrameEpochString

public void setFrameEpochString(String frameEpochString)

Set epoch of reference frame, if not intrinsic to the definition of the reference frame.

Parameters:

frameEpochString - the epoch of reference frame to be set

getFrameEpoch

public AbsoluteDate getFrameEpoch()

Get epoch of reference frame, if not intrinsic to the definition of the reference frame.

Returns:

epoch of reference frame

setFrameEpoch

public void setFrameEpoch(AbsoluteDate frameEpoch)

Set epoch of reference frame, if not intrinsic to the definition of the reference frame.

Parameters:

frameEpoch - the epoch of reference frame 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