Package jmri.implementation
Class AbstractIdTagReporter
- java.lang.Object
-
- jmri.implementation.AbstractNamedBean
-
- jmri.implementation.AbstractReporter
-
- jmri.implementation.AbstractIdTagReporter
-
- All Implemented Interfaces:
java.lang.Comparable<NamedBean>
,PropertyChangeProvider
,IdTagListener
,NamedBean
,PhysicalLocationReporter
,Reporter
- Direct Known Subclasses:
AbstractRailComReporter
,LnReporter
,MqttReporter
,OlcbReporter
,RfidReporter
public class AbstractIdTagReporter extends AbstractReporter implements IdTagListener, PhysicalLocationReporter
Extend AbstractReporter for IdTag reportersThis file is based on @{link jmri.jmrix.rfid.RfidReporter}
- Since:
- 4.15.3
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface jmri.NamedBean
NamedBean.BadNameException, NamedBean.BadSystemNameException, NamedBean.BadUserNameException, NamedBean.DisplayOptions, NamedBean.DuplicateSystemNameException
-
Nested classes/interfaces inherited from interface jmri.PhysicalLocationReporter
PhysicalLocationReporter.Direction
-
-
Field Summary
-
Fields inherited from class jmri.implementation.AbstractReporter
_currentReport, _lastReport
-
Fields inherited from class jmri.implementation.AbstractNamedBean
listenerRefs, mSystemName, register
-
Fields inherited from interface jmri.NamedBean
DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_STATE, QUOTED_NAME_FORMAT, UNKNOWN
-
-
Constructor Summary
Constructors Constructor Description AbstractIdTagReporter(java.lang.String systemName)
AbstractIdTagReporter(java.lang.String systemName, java.lang.String userName)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
describeState(int state)
Provide human-readable, localized version of state value.PhysicalLocationReporter.Direction
getDirection(java.lang.String rep)
Gets the direction (ENTER/EXIT) of the report.LocoAddress
getLocoAddress(java.lang.String rep)
Get the locomotive address we're reporting about from the current report.PhysicalLocation
getPhysicalLocation()
Get the PhysicalLocation of the Reporter Reports its own location, for now.PhysicalLocation
getPhysicalLocation(java.lang.String s)
Get the PhysicalLocation of the Reporter.int
getState()
Provide an integer form of the last report.void
notify(IdTag id)
void
setState(int s)
Provide generic access to internal state.-
Methods inherited from class jmri.implementation.AbstractReporter
getBeanType, getCurrentReport, getLastReport, setReport
-
Methods inherited from class jmri.implementation.AbstractNamedBean
addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, dispose, equals, firePropertyChange, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, hashCode, removeProperty, removePropertyChangeListener, removePropertyChangeListener, setComment, setProperty, setUserName, toString, toStringSuffix, updateListenerRef, vetoableChange
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface jmri.NamedBean
addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, dispose, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUsageReport, getUserName, removeProperty, setComment, setProperty, setUserName, toString, updateListenerRef, vetoableChange
-
Methods inherited from interface jmri.beans.PropertyChangeProvider
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
-
-
-
Constructor Detail
-
AbstractIdTagReporter
public AbstractIdTagReporter(java.lang.String systemName)
-
AbstractIdTagReporter
public AbstractIdTagReporter(java.lang.String systemName, java.lang.String userName)
-
-
Method Detail
-
notify
public void notify(IdTag id)
- Specified by:
notify
in interfaceIdTagListener
-
setState
public void setState(int s)
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.
-
getState
public int getState()
Provide an integer form of the last report.
-
describeState
@Nonnull public java.lang.String describeState(int state)
Provide human-readable, localized version of state value.This method is intended for use when presenting to a human operator.
- Specified by:
describeState
in interfaceNamedBean
- Overrides:
describeState
in classAbstractNamedBean
- Parameters:
state
- the state to describe- Returns:
- the state in localized form
-
getLocoAddress
public LocoAddress getLocoAddress(java.lang.String rep)
Get the locomotive address we're reporting about from the current report.- Specified by:
getLocoAddress
in interfacePhysicalLocationReporter
- Parameters:
rep
- ignored, IdTag Reporters don't send String type reports.
-
getDirection
public PhysicalLocationReporter.Direction getDirection(java.lang.String rep)
Gets the direction (ENTER/EXIT) of the report.Because of the way IdTag Reporters work, all reports are ENTER type.
- Specified by:
getDirection
in interfacePhysicalLocationReporter
-
getPhysicalLocation
public PhysicalLocation getPhysicalLocation()
Get the PhysicalLocation of the Reporter Reports its own location, for now. Not sure if that's the right thing or not. NOT DONE YET- Specified by:
getPhysicalLocation
in interfacePhysicalLocationReporter
-
getPhysicalLocation
public PhysicalLocation getPhysicalLocation(java.lang.String s)
Get the PhysicalLocation of the Reporter.- Specified by:
getPhysicalLocation
in interfacePhysicalLocationReporter
- Parameters:
s
- unused.
-
-