org.orekit.files.ccsds.ndm.adm.acm

Class AcmMetadata

java.lang.Object

org.orekit.files.ccsds.section.CommentsContainer

org.orekit.files.ccsds.section.Metadata

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

org.orekit.files.ccsds.ndm.adm.acm.AcmMetadata

All Implemented Interfaces:

Section

public class AcmMetadata
extends AdmMetadata

Meta-data for Attitude Comprehensive Message.

Since:

12.0

Constructor Summary

Constructors

Constructor and Description
AcmMetadata(DataContext dataContext) Create a new meta-data.

Method Summary

Modifier and Type	Method and Description
List<AcmElements>	getAcmDataElements() Get the list of elements of information data blocks included in this message.
String	getCatalogName() Get the specification of satellite catalog source.
AbsoluteDate	getEpochT0() Get the epoch to which all relative times are referenced in data blocks.
String	getInternationalDesignator() Get the international designator for the object.
AbsoluteDate	getNextLeapEpoch() Get the epoch of next leap second.
double	getNextLeapTaimutc() Get the difference (TAI – UTC) in seconds incorporated at epoch getNextLeapEpoch().
String	getObjectDesignator() Get the unique satellite identification designator for the object.
String	getOdmMessageLink() Get the Unique identifier of Orbit Data Message linked to this Attitude Data Message.
String	getOriginatorAddress() Get the address of Programmatic Point Of Contact at originator.
String	getOriginatorEmail() Get the email address of Programmatic Point Of Contact at originator.
String	getOriginatorPhone() Get the phone number of Programmatic Point Of Contact at originator.
String	getOriginatorPOC() Get the programmatic Point Of Contact at originator.
String	getOriginatorPosition() Get the position of Programmatic Point Of Contact at originator.
AbsoluteDate	getStartTime() Get the time of the earliest data contained in the OCM.
AbsoluteDate	getStopTime() Get the time of the latest data contained in the OCM.
double	getTaimutcT0() Get the difference (TAI – UTC) in seconds at epoch getEpochT0().
void	setAcmDataElements(List<AcmElements> acmDataElements) Set the list of elements of information data blocks included in this message.
void	setCatalogName(String catalogName) Set the specification of satellite catalog source.
void	setEpochT0(AbsoluteDate epochT0) Set the epoch to which all relative times are referenced in data blocks.
void	setInternationalDesignator(String internationalDesignator) Set the international designator for the object.
void	setNextLeapEpoch(AbsoluteDate nextLeapEpoch) Set the epoch of next leap second.
void	setNextLeapTaimutc(double nextLeapTaimutc) Set the difference (TAI – UTC) in seconds incorporated at epoch getNextLeapEpoch().
void	setObjectDesignator(String objectDesignator) Set the unique satellite identification designator for the object.
void	setOdmMessageLink(String odmMessageLink) Set the Unique identifier of Orbit Data Message linked to this Attitude Data Message.
void	setOriginatorAddress(String originatorAddress) Set the address of Programmatic Point Of Contact at originator.
void	setOriginatorEmail(String originatorEmail) Set the email address of Programmatic Point Of Contact at originator.
void	setOriginatorPhone(String originatorPhone) Set the phone number of Programmatic Point Of Contact at originator.
void	setOriginatorPOC(String originatorPOC) Set the programmatic Point Of Contact at originator.
void	setOriginatorPosition(String originatorPosition) Set the position of Programmatic Point Of Contact at originator.
void	setStartTime(AbsoluteDate startTime) Set the time of the earliest data contained in the OCM.
void	setStopTime(AbsoluteDate stopTime) Set the time of the latest data contained in the OCM.
void	setTaimutcT0(double taimutcT0) Set the difference (TAI – UTC) in seconds at epoch getEpochT0().
void	validate(double version) Check is all mandatory entries have been initialized.

Methods inherited from class org.orekit.files.ccsds.ndm.adm.AdmMetadata

getCenter, getHasCreatableBody, getLaunchNumber, getLaunchPiece, getLaunchYear, getObjectID, getObjectName, setCenter, setObjectID, setObjectName

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

AcmMetadata

public AcmMetadata(DataContext dataContext)

Create a new meta-data.

Parameters:

dataContext - data context

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 AdmMetadata

Parameters:

version - format version

getInternationalDesignator

public String getInternationalDesignator()

Get the international designator for the object.

Returns:

international designator for the object

setInternationalDesignator

public void setInternationalDesignator(String internationalDesignator)

Set the international designator for the object.

Parameters:

internationalDesignator - international designator for the object

getCatalogName

public String getCatalogName()

Get the specification of satellite catalog source.

Returns:

specification of satellite catalog source

setCatalogName

public void setCatalogName(String catalogName)

Set the specification of satellite catalog source.

Parameters:

catalogName - specification of satellite catalog source

getObjectDesignator

public String getObjectDesignator()

Get the unique satellite identification designator for the object.

Returns:

unique satellite identification designator for the object.

setObjectDesignator

public void setObjectDesignator(String objectDesignator)

Set the unique satellite identification designator for the object.

Parameters:

objectDesignator - unique satellite identification designator for the object

getOriginatorPOC

public String getOriginatorPOC()

Get the programmatic Point Of Contact at originator.

Returns:

programmatic Point Of Contact at originator

setOriginatorPOC

public void setOriginatorPOC(String originatorPOC)

Set the programmatic Point Of Contact at originator.

Parameters:

originatorPOC - programmatic Point Of Contact at originator

getOriginatorPosition

public String getOriginatorPosition()

Get the position of Programmatic Point Of Contact at originator.

Returns:

position of Programmatic Point Of Contact at originator

setOriginatorPosition

public void setOriginatorPosition(String originatorPosition)

Set the position of Programmatic Point Of Contact at originator.

Parameters:

originatorPosition - position of Programmatic Point Of Contact at originator

getOriginatorPhone

public String getOriginatorPhone()

Get the phone number of Programmatic Point Of Contact at originator.

Returns:

phone number of Programmatic Point Of Contact at originator

setOriginatorPhone

public void setOriginatorPhone(String originatorPhone)

Set the phone number of Programmatic Point Of Contact at originator.

Parameters:

originatorPhone - phone number of Programmatic Point Of Contact at originator

getOriginatorEmail

public String getOriginatorEmail()

Get the email address of Programmatic Point Of Contact at originator.

Returns:

email address of Programmatic Point Of Contact at originator

setOriginatorEmail

public void setOriginatorEmail(String originatorEmail)

Set the email address of Programmatic Point Of Contact at originator.

Parameters:

originatorEmail - email address of Programmatic Point Of Contact at originator

getOriginatorAddress

public String getOriginatorAddress()

Get the address of Programmatic Point Of Contact at originator.

Returns:

address of Programmatic Point Of Contact at originator

setOriginatorAddress

public void setOriginatorAddress(String originatorAddress)

Set the address of Programmatic Point Of Contact at originator.

Parameters:

originatorAddress - address of Programmatic Point Of Contact at originator

getOdmMessageLink

public String getOdmMessageLink()

Get the Unique identifier of Orbit Data Message linked to this Attitude Data Message.

Returns:

Unique identifier of Orbit Data Message linked to this Attitude Data Message

setOdmMessageLink

public void setOdmMessageLink(String odmMessageLink)

Set the Unique identifier of Orbit Data Message linked to this Attitude Data Message.

Parameters:

odmMessageLink - Unique identifier of Orbit Data Message linked to this Attitude Data Message

getEpochT0

public AbsoluteDate getEpochT0()

Get the epoch to which all relative times are referenced in data blocks.

Returns:

epoch to which all relative times are referenced in data blocks

setEpochT0

public void setEpochT0(AbsoluteDate epochT0)

Set the epoch to which all relative times are referenced in data blocks.

Parameters:

epochT0 - epoch to which all relative times are referenced in data blocks

getAcmDataElements

public List<AcmElements> getAcmDataElements()

Get the list of elements of information data blocks included in this message.

Returns:

list of elements of information data blocks included in this message

setAcmDataElements

public void setAcmDataElements(List<AcmElements> acmDataElements)

Set the list of elements of information data blocks included in this message.

Parameters:

acmDataElements - list of elements of information data blocks included in this message

getStartTime

public AbsoluteDate getStartTime()

Get the time of the earliest data contained in the OCM.

Returns:

time of the earliest data contained in the OCM

setStartTime

public void setStartTime(AbsoluteDate startTime)

Set the time of the earliest data contained in the OCM.

Parameters:

startTime - time of the earliest data contained in the OCM

getStopTime

public AbsoluteDate getStopTime()

Get the time of the latest data contained in the OCM.

Returns:

time of the latest data contained in the OCM

setStopTime

public void setStopTime(AbsoluteDate stopTime)

Set the time of the latest data contained in the OCM.

Parameters:

stopTime - time of the latest data contained in the OCM

getTaimutcT0

public double getTaimutcT0()

Get the difference (TAI – UTC) in seconds at epoch getEpochT0().

Returns:

difference (TAI – UTC) in seconds at epoch getEpochT0()

setTaimutcT0

public void setTaimutcT0(double taimutcT0)

Set the difference (TAI – UTC) in seconds at epoch getEpochT0().

Parameters:

taimutcT0 - difference (TAI – UTC) in seconds at epoch getEpochT0()

getNextLeapEpoch

public AbsoluteDate getNextLeapEpoch()

Get the epoch of next leap second.

Returns:

epoch of next leap second

setNextLeapEpoch

public void setNextLeapEpoch(AbsoluteDate nextLeapEpoch)

Set the epoch of next leap second.

Parameters:

nextLeapEpoch - epoch of next leap second

getNextLeapTaimutc

public double getNextLeapTaimutc()

Get the difference (TAI – UTC) in seconds incorporated at epoch getNextLeapEpoch().

Returns:

difference (TAI – UTC) in seconds incorporated at epoch getNextLeapEpoch()

setNextLeapTaimutc

public void setNextLeapTaimutc(double nextLeapTaimutc)

Set the difference (TAI – UTC) in seconds incorporated at epoch getNextLeapEpoch().

Parameters:

nextLeapTaimutc - difference (TAI – UTC) in seconds incorporated at epoch getNextLeapEpoch()