Interface Clock

  • All Superinterfaces:
    IdentifiedObject, ReferenceSystem, TemporalReferenceSystem

    @UML(identifier="TM_Clock",
         specification=ISO_19108)
    public interface Clock
    extends TemporalReferenceSystem
    Provides a basis for defining temporal position within a day.
    Since:
    2.3
    • Field Summary

      • Fields inherited from interface IdentifiedObject

        ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
      • Fields inherited from interface ReferenceSystem

        DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY
    • Method Detail

      • getReferenceEvent

        @UML(identifier="referenceEvent",
             obligation=MANDATORY,
             specification=ISO_19108)
        InternationalString getReferenceEvent()
        Returns event used as the datum for this clock.
        Returns:
        event used as the datum for this clock.
      • getReferenceTime

        @UML(identifier="referenceTime",
             obligation=MANDATORY,
             specification=ISO_19108)
        ClockTime getReferenceTime()
        Returns time of the reference event for this clock, usually the origin of the clock scale.
        Returns:
        time of the reference event for this clock, usually the origin of the clock scale.
      • getUTCReference

        @UML(identifier="utcReference",
             obligation=MANDATORY,
             specification=ISO_19108)
        ClockTime getUTCReference()
        Returns the 24-hour local or UTC time that corresponds to the reference time.
        Returns:
        the 24-hour local or UTC time that corresponds to the reference time.
      • clkTrans

        @UML(identifier="clkTrans",
             obligation=MANDATORY,
             specification=ISO_19108)
        ClockTime clkTrans​(ClockTime uTime)
        Returns convertion of an UTC time to a time on this clock.
        Parameters:
        uTime - the UTC time which will be convert.
        Returns:
        convertion of an UTC time to a time on this clock.
      • utcTrans

        @UML(identifier="utcTrans",
             obligation=MANDATORY,
             specification=ISO_19108)
        ClockTime utcTrans​(ClockTime clockTime)
        Returns convertion from time on this clock to UTC time.
        Parameters:
        clockTime - the clock time which will be convert.
        Returns:
        convertion from time on this clock to UTC time.