Class DefaultMeter

    • Method Detail

      • enable

        public void enable()
        Enable this meter
        Specified by:
        enable in interface Meter
      • disable

        public void disable()
        Disable this meter
        Specified by:
        disable in interface Meter
      • sendValueToLayout

        protected void sendValueToLayout​(double value)
                                  throws JmriException
        Sends the string to the layout. The string [u]must not[/u] be longer than the value of getMaximumLength() unless that value is zero. Some microcomputers have little memory and it's very important that this method is never called with too long strings.

        Override this if the meter can send value to the layout.

        Specified by:
        sendValueToLayout in class AbstractAnalogIO
        Parameters:
        value - the desired string value
        Throws:
        JmriException - general error when setting the value fails
      • cutOutOfBoundsValues

        protected boolean cutOutOfBoundsValues()
        Cut out of bounds values instead of throwing an exception? For example, if the AnalogIO is a display, it could be desired to accept too long strings. On the other hand, if the AnalogIO is used to send a command, a too long string is an error.
        Specified by:
        cutOutOfBoundsValues in class AbstractAnalogIO
        Returns:
        true if long strings should be cut
      • setState

        public void setState​(int s)
                      throws JmriException
        Provide generic access to internal state.

        This generally shouldn't be used by Java code; use the class-specific form instead (e.g. setCommandedState in Turnout). This is provided to make scripts access easier to read.

        Specified by:
        setState in interface NamedBean
        Parameters:
        s - the state
        Throws:
        JmriException - general error when setting the state fails
      • getState

        public int getState()
        Provide generic access to internal state.

        This generally shouldn't be used by Java code; use the class-specific form instead (e.g. getCommandedState in Turnout). This is provided to make scripts easier to read.

        Specified by:
        getState in interface NamedBean
        Returns:
        the state
      • getBeanType

        public java.lang.String getBeanType()
        For instances in the code where we are dealing with just a bean and a message needs to be passed to the user or in a log.
        Specified by:
        getBeanType in interface NamedBean
        Overrides:
        getBeanType in class AbstractAnalogIO
        Returns:
        a string of the bean type, eg Turnout, Sensor etc
      • getMin

        public double getMin()
        Get the minimum value of this AnalogIO.
        Specified by:
        getMin in interface AnalogIO
        Returns:
        minimum value.
      • getMax

        public double getMax()
        Get the maximum value of this AnalogIO.
        Specified by:
        getMax in interface AnalogIO
        Returns:
        maximum value.
      • dispose

        public void dispose()
        Deactivate this object, so that it releases as many resources as possible and no longer effects others.

        For example, if this object has listeners, after a call to this method it should no longer notify those listeners. Any native or system-wide resources it maintains should be released, including threads, files, etc.

        It is an error to invoke any other methods on this object once dispose() has been called. Note, however, that there is no guarantee about behavior in that case.

        Afterwards, references to this object may still exist elsewhere, preventing its garbage collection. But it's formally dead, and shouldn't be keeping any other objects alive. Therefore, this method should null out any references to other objects that this NamedBean contained.

        Specified by:
        dispose in interface Meter
        Specified by:
        dispose in interface NamedBean
        Overrides:
        dispose in class AbstractNamedBean