Package org.orekit.files.ccsds.ndm.odm.ocm

Class OcmMetadata

    • Field Detail

      • DEFAULT_SCLK_OFFSET_AT_EPOCH

        public static final double DEFAULT_SCLK_OFFSET_AT_EPOCH
        Default value for SCLK_OFFSET_AT_EPOCH.
        Since:
        12.0
        See Also:
        Constant Field Values

      • DEFAULT_SCLK_SEC_PER_SI_SEC

        public static final double DEFAULT_SCLK_SEC_PER_SI_SEC
        Default value for SCLK_SEC_PER_SI_SEC.
        Since:
        12.0
        See Also:
        Constant Field Values

    • Constructor Detail

      • OcmMetadata

        public OcmMetadata​(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 Metadata
        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

      • getAlternateNames

        public List<String> getAlternateNames()
        Get the alternate names for this space object.
        Returns:
        alternate names

      • setAlternateNames

        public void setAlternateNames​(List<String> alternateNames)
        Set the alternate names for this space object.
        Parameters:
        alternateNames - alternate names

      • 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
        Since:
        11.2

      • 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
        Since:
        11.2

      • 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

      • getTechOrg

        public String getTechOrg()
        Get the creating agency or operator.
        Returns:
        creating agency or operator

      • setTechOrg

        public void setTechOrg​(String techOrg)
        Set the creating agency or operator.
        Parameters:
        techOrg - creating agency or operator

      • getTechPOC

        public String getTechPOC()
        Get the Technical Point Of Contact at originator.
        Returns:
        Technical Point Of Contact at originator

      • setTechPOC

        public void setTechPOC​(String techPOC)
        Set the Technical Point Of Contact at originator.
        Parameters:
        techPOC - Technical Point Of Contact at originator

      • getTechPosition

        public String getTechPosition()
        Get the position of Technical Point Of Contact at originator.
        Returns:
        position of Technical Point Of Contact at originator

      • setTechPosition

        public void setTechPosition​(String techPosition)
        Set the position of Technical Point Of Contact at originator.
        Parameters:
        techPosition - position of Technical Point Of Contact at originator

      • getTechPhone

        public String getTechPhone()
        Get the phone number of Technical Point Of Contact at originator.
        Returns:
        phone number of Technical Point Of Contact at originator

      • setTechPhone

        public void setTechPhone​(String techPhone)
        Set the phone number of Technical Point Of Contact at originator.
        Parameters:
        techPhone - phone number of Technical Point Of Contact at originator

      • getTechEmail

        public String getTechEmail()
        Get the email address of Technical Point Of Contact at originator.
        Returns:
        email address of Technical Point Of Contact at originator
        Since:
        11.2

      • setTechEmail

        public void setTechEmail​(String techEmail)
        Set the email address of Technical Point Of Contact at originator.
        Parameters:
        techEmail - email address of Technical Point Of Contact at originator
        Since:
        11.2

      • getTechAddress

        public String getTechAddress()
        Get the address of Technical Point Of Contact at originator.
        Returns:
        address of Technical Point Of Contact at originator

      • setTechAddress

        public void setTechAddress​(String techAddress)
        Set the address of Technical Point Of Contact at originator.
        Parameters:
        techAddress - address of Technical Point Of Contact at originator

      • getPreviousMessageID

        public String getPreviousMessageID()
        Get the unique ID identifying previous message from a given originator.
        Returns:
        unique ID identifying previous message from a given originator

      • setPreviousMessageID

        public void setPreviousMessageID​(String previousMessageID)
        Set the unique ID identifying previous message from a given originator.
        Parameters:
        previousMessageID - unique ID identifying previous message from a given originator

      • getNextMessageID

        public String getNextMessageID()
        Get the unique ID identifying next message from a given originator.
        Returns:
        unique ID identifying next message from a given originator

      • setNextMessageID

        public void setNextMessageID​(String nextMessageID)
        Set the unique ID identifying next message from a given originator.
        Parameters:
        nextMessageID - unique ID identifying next message from a given originator

      • getAdmMessageLink

        public String getAdmMessageLink()
        Get the Unique identifier of Attitude Data Message linked to this Orbit Data Message.
        Returns:
        Unique identifier of Attitude Data Message linked to this Orbit Data Message

      • setAdmMessageLink

        public void setAdmMessageLink​(String admMessageLink)
        Set the Unique identifier of Attitude Data Message linked to this Orbit Data Message.
        Parameters:
        admMessageLink - Unique identifier of Attitude Data Message linked to this Orbit Data Message

      • getCdmMessageLink

        public String getCdmMessageLink()
        Get the Unique identifier of Conjunction Data Message linked to this Orbit Data Message.
        Returns:
        Unique identifier of Conjunction Data Message linked to this Orbit Data Message

      • setCdmMessageLink

        public void setCdmMessageLink​(String cdmMessageLink)
        Set the Unique identifier of Conjunction Data Message linked to this Orbit Data Message.
        Parameters:
        cdmMessageLink - Unique identifier of Conjunction Data Message linked to this Orbit Data Message

      • getPrmMessageLink

        public String getPrmMessageLink()
        Get the Unique identifier of Pointing Request Message linked to this Orbit Data Message.
        Returns:
        Unique identifier of Pointing Request Message linked to this Orbit Data Message

      • setPrmMessageLink

        public void setPrmMessageLink​(String prmMessageLink)
        Set the Unique identifier of Pointing Request Message linked to this Orbit Data Message.
        Parameters:
        prmMessageLink - Unique identifier of Pointing Request Message linked to this Orbit Data Message

      • getRdmMessageLink

        public String getRdmMessageLink()
        Get the Unique identifier of Reentry Data Message linked to this Orbit Data Message.
        Returns:
        Unique identifier of Reentry Data Message linked to this Orbit Data Message

      • setRdmMessageLink

        public void setRdmMessageLink​(String rdmMessageLink)
        Set the Unique identifier of Reentry Data Message linked to this Orbit Data Message.
        Parameters:
        rdmMessageLink - Unique identifier of Reentry Data Message linked to this Orbit Data Message

      • getTdmMessageLink

        public String getTdmMessageLink()
        Get the Unique identifier of Tracking Data Message linked to this Orbit Data Message.
        Returns:
        Unique identifier of Tracking Data Message linked to this Orbit Data Message

      • setTdmMessageLink

        public void setTdmMessageLink​(String tdmMessageLink)
        Set the Unique identifier of Tracking Data Message linked to this Orbit Data Message.
        Parameters:
        tdmMessageLink - Unique identifier of Tracking Data Message linked to this Orbit Data Message

      • getOperator

        public String getOperator()
        Get the operator of the space object.
        Returns:
        operator of the space object

      • setOperator

        public void setOperator​(String operator)
        Set the operator of the space object.
        Parameters:
        operator - operator of the space object

      • getOwner

        public String getOwner()
        Get the owner of the space object.
        Returns:
        owner of the space object

      • setOwner

        public void setOwner​(String owner)
        Set the owner of the space object.
        Parameters:
        owner - owner of the space object

      • getCountry

        public String getCountry()
        Get the name of the country where the space object owner is based.
        Returns:
        name of the country where the space object owner is based

      • setCountry

        public void setCountry​(String country)
        Set the name of the country where the space object owner is based.
        Parameters:
        country - name of the country where the space object owner is based

      • getConstellation

        public String getConstellation()
        Get the name of the constellation this space object belongs to.
        Returns:
        name of the constellation this space object belongs to

      • setConstellation

        public void setConstellation​(String constellation)
        Set the name of the constellation this space object belongs to.
        Parameters:
        constellation - name of the constellation this space object belongs to

      • getObjectType

        public ObjectType getObjectType()
        Get the type of object.
        Returns:
        type of object

      • setObjectType

        public void setObjectType​(ObjectType objectType)
        Set the type of object.
        Parameters:
        objectType - type of object

      • 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

      • getOpsStatus

        public OpsStatus getOpsStatus()
        Get the operational status.
        Returns:
        operational status

      • setOpsStatus

        public void setOpsStatus​(OpsStatus opsStatus)
        Set the operational status.
        Parameters:
        opsStatus - operational status

      • getOrbitCategory

        public OrbitCategory getOrbitCategory()
        Get the orbit category.
        Returns:
        orbit category

      • setOrbitCategory

        public void setOrbitCategory​(OrbitCategory orbitCategory)
        Set the orbit category.
        Parameters:
        orbitCategory - orbit category

      • getOcmDataElements

        public List<OcmElements> getOcmDataElements()
        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

      • setOcmDataElements

        public void setOcmDataElements​(List<OcmElements> ocmDataElements)
        Set the list of elements of information data blocks included in this message.
        Parameters:
        ocmDataElements - list of elements of information data blocks included in this message

      • getSclkOffsetAtEpoch

        public double getSclkOffsetAtEpoch()
        Get the spacecraft clock count at getEpochT0().
        Returns:
        spacecraft clock count at getEpochT0()

      • setSclkOffsetAtEpoch

        public void setSclkOffsetAtEpoch​(double sclkOffsetAtEpoch)
        Set the spacecraft clock count at getEpochT0().
        Parameters:
        sclkOffsetAtEpoch - spacecraft clock count at getEpochT0()

      • getSclkSecPerSISec

        public double getSclkSecPerSISec()
        Get the number of spacecraft clock seconds occurring during one SI second.
        Returns:
        number of spacecraft clock seconds occurring during one SI second

      • setSclkSecPerSISec

        public void setSclkSecPerSISec​(double secClockPerSISec)
        Set the number of spacecraft clock seconds occurring during one SI second.
        Parameters:
        secClockPerSISec - number of spacecraft clock seconds occurring during one SI second

      • getPreviousMessageEpoch

        public AbsoluteDate getPreviousMessageEpoch()
        Get the creation date of previous message from a given originator.
        Returns:
        creation date of previous message from a given originator

      • setPreviousMessageEpoch

        public void setPreviousMessageEpoch​(AbsoluteDate previousMessageEpoch)
        Set the creation date of previous message from a given originator.
        Parameters:
        previousMessageEpoch - creation date of previous message from a given originator

      • getNextMessageEpoch

        public AbsoluteDate getNextMessageEpoch()
        Get the creation date of next message from a given originator.
        Returns:
        creation date of next message from a given originator

      • setNextMessageEpoch

        public void setNextMessageEpoch​(AbsoluteDate nextMessageEpoch)
        Set the creation date of next message from a given originator.
        Parameters:
        nextMessageEpoch - creation date of next message from a given originator

      • 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

      • getTimeSpan

        public double getTimeSpan()
        Get the span of time in seconds that the OCM covers.
        Returns:
        span of time in seconds that the OCM covers

      • setTimeSpan

        public void setTimeSpan​(double timeSpan)
        Set the span of time in seconds that the OCM covers.
        Parameters:
        timeSpan - span of time in seconds that the OCM covers

      • 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
        Since:
        11.2

      • setNextLeapEpoch

        public void setNextLeapEpoch​(AbsoluteDate nextLeapEpoch)
        Set the epoch of next leap second.
        Parameters:
        nextLeapEpoch - epoch of next leap second
        Since:
        11.2

      • 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()
        Since:
        11.2

      • 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()
        Since:
        11.2

      • getUt1mutcT0

        public double getUt1mutcT0()
        Get the difference (UT1 – UTC) in seconds at epoch getEpochT0().
        Returns:
        difference (UT1 – UTC) in seconds at epoch getEpochT0()

      • setUt1mutcT0

        public void setUt1mutcT0​(double ut1mutcT0)
        Set the difference (UT1 – UTC) in seconds at epoch getEpochT0().
        Parameters:
        ut1mutcT0 - difference (UT1 – UTC) in seconds at epoch getEpochT0()

      • getEopSource

        public String getEopSource()
        Get the source and version of Earth Orientation Parameters.
        Returns:
        source and version of Earth Orientation Parameters

      • setEopSource

        public void setEopSource​(String eopSource)
        Set the source and version of Earth Orientation Parameters.
        Parameters:
        eopSource - source and version of Earth Orientation Parameters

      • getInterpMethodEOP

        public String getInterpMethodEOP()
        Get the interpolation method for Earth Orientation Parameters.
        Returns:
        interpolation method for Earth Orientation Parameters

      • setInterpMethodEOP

        public void setInterpMethodEOP​(String interpMethodEOP)
        Set the interpolation method for Earth Orientation Parameters.
        Parameters:
        interpMethodEOP - interpolation method for Earth Orientation Parameters

      • getCelestialSource

        public String getCelestialSource()
        Get the source and version of celestial body (e.g. Sun/Earth/Planetary).
        Returns:
        source and version of celestial body (e.g. Sun/Earth/Planetary)

      • setCelestialSource

        public void setCelestialSource​(String celestialSource)
        Set the source and version of celestial body (e.g. Sun/Earth/Planetary).
        Parameters:
        celestialSource - source and version of celestial body (e.g. Sun/Earth/Planetary)

      • copy

        public OcmMetadata copy​(double version)
        Copy the instance, making sure mandatory fields have been initialized.

        Message ID, previous/next references, start and stop times are not copied.

        Parameters:
        version - format version
        Returns:
        a new copy
        Since:
        12.0