Package jmri

Interface Meter

All Superinterfaces:

AnalogIO, Comparable<NamedBean>, NamedBean, PropertyChangeProvider

All Known Subinterfaces:

AverageMeter, CurrentMeter, VoltageMeter

All Known Implementing Classes:

DefaultAverageMeter, DefaultMeter, DefaultMeter.DefaultCurrentMeter, DefaultMeter.DefaultVoltageMeter

public interface Meter
extends AnalogIO

Interface for displaying (and controlling where appropriate) Current, Voltage, and other status data from the layout.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Meter.Unit

Nested classes/interfaces inherited from interface jmri.AnalogIO

AnalogIO.AbsoluteOrRelative

Nested classes/interfaces inherited from interface jmri.NamedBean

NamedBean.BadNameException, NamedBean.BadSystemNameException, NamedBean.BadUserNameException, NamedBean.DisplayOptions, NamedBean.DuplicateSystemNameException

Field Summary

Fields inherited from interface jmri.NamedBean

DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_COMMENT, PROPERTY_ENABLED, PROPERTY_KNOWN_STATE, PROPERTY_STATE, PROPERTY_USERNAME, QUOTED_NAME_FORMAT, UNKNOWN

Method Summary

Modifier and Type	Method	Description
void	disable()	Disable this meter
void	dispose()	Remove references to and from this object, so that it can eventually be garbage-collected.
void	enable()	Enable this meter
Meter.Unit	getUnit()

Methods inherited from interface jmri.AnalogIO

getAbsoluteOrRelative, getCommandedAnalogValue, getKnownAnalogValue, getMax, getMin, getResolution, getState, isConsistentValue, requestUpdateFromLayout, setCommandedAnalogValue, setState

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, describeState, getBeanType, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getRecommendedToolTip, getState, getSystemName, getUsageReport, getUserName, removeProperty, setComment, setProperty, setState, setUserName, toString, updateListenerRef, vetoableChange

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Method Details

getUnit

Meter.Unit getUnit()

enable

void enable()

Enable this meter

disable

void disable()

Disable this meter

dispose

void dispose()

Remove references to and from this object, so that it can eventually be garbage-collected.

The meter must be disabled before it's disposed.

Specified by:

dispose in interface NamedBean