org.orekit.files.ccsds.section

Class Metadata

java.lang.Object

org.orekit.files.ccsds.section.CommentsContainer

org.orekit.files.ccsds.section.Metadata

All Implemented Interfaces:

Section

Direct Known Subclasses:

AdmMetadata, OdmMetadata, TdmMetadata

public class Metadata
extends CommentsContainer

This class gathers the meta-data present in the Navigation Data Message (ADM, ODM and TDM).

Since:

11.0

Author:

Luc Maisonobe

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Metadata(TimeSystem defaultTimeSystem) Simple constructor.

Method Summary

Modifier and Type	Method and Description
protected int	getLaunchNumber(String objectID) Get the launch number.
protected String	getLaunchPiece(String objectID) Get the piece of launch.
protected int	getLaunchYear(String objectID) Get the launch year.
TimeSystem	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	setTimeSystem(TimeSystem 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.
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

Metadata

protected Metadata(TimeSystem defaultTimeSystem)

Simple constructor.

Parameters:

defaultTimeSystem - default time system (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

Overrides:

validate in class CommentsContainer

Parameters:

version - format version

getTimeSystem

public TimeSystem 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(TimeSystem 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

getLaunchYear

protected int getLaunchYear(String objectID)

Get the launch year.

Parameters:

objectID - object identifier

Returns:

launch year

getLaunchNumber

protected int getLaunchNumber(String objectID)

Get the launch number.

Parameters:

objectID - object identifier

Returns:

launch number

getLaunchPiece

protected String getLaunchPiece(String objectID)

Get the piece of launch.

Parameters:

objectID - object identifier

Returns:

piece of launch