Class InstanceTime

  • All Implemented Interfaces:
    java.lang.Comparable

    public class InstanceTime
    extends java.lang.Object
    implements java.lang.Comparable
    A class that represents an instance time created from a timing specification.
    Version:
    $Id: InstanceTime.java 1802297 2017-07-18 13:58:12Z ssteiner $
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean clearOnReset
      Whether this InstanceTime should be removed from an element's begin or end instance time lists upon reset.
      protected TimingSpecifier creator
      The TimingSpecifier that created this InstanceTime.
      protected float time
      The time.
    • Constructor Summary

      Constructors 
      Constructor Description
      InstanceTime​(TimingSpecifier creator, float time, boolean clearOnReset)
      Creates a new InstanceTime.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compareTo​(java.lang.Object o)
      Compares this InstanceTime with another.
      (package private) float dependentUpdate​(float newTime)
      Called by the dependent Interval to indicate that its time has changed.
      boolean getClearOnReset()
      Returns whether the InstanceTime should be removed from the element's begin or end instance time list when it is reset.
      float getTime()
      Returns the time of this instance time.
      java.lang.String toString()
      Returns a string representation of this InstanceTime.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • time

        protected float time
        The time.
      • clearOnReset

        protected boolean clearOnReset
        Whether this InstanceTime should be removed from an element's begin or end instance time lists upon reset.
    • Constructor Detail

      • InstanceTime

        public InstanceTime​(TimingSpecifier creator,
                            float time,
                            boolean clearOnReset)
        Creates a new InstanceTime.
        Parameters:
        creator - the TimingSpecifier that created this InstanceTime
        time - the new time, in parent simple time
        clearOnReset - whether this InstanceTime should be removed from an instance time list upon element reset
    • Method Detail

      • getClearOnReset

        public boolean getClearOnReset()
        Returns whether the InstanceTime should be removed from the element's begin or end instance time list when it is reset.
      • getTime

        public float getTime()
        Returns the time of this instance time.
      • dependentUpdate

        float dependentUpdate​(float newTime)
        Called by the dependent Interval to indicate that its time has changed.
        Parameters:
        newTime - the new time, in parent simple time
      • toString

        public java.lang.String toString()
        Returns a string representation of this InstanceTime.
        Overrides:
        toString in class java.lang.Object
      • compareTo

        public int compareTo​(java.lang.Object o)
        Compares this InstanceTime with another.
        Specified by:
        compareTo in interface java.lang.Comparable