Package jmri.implementation

Class AbstractIdTagReporter

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractReporter

jmri.implementation.AbstractIdTagReporter

All Implemented Interfaces:

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 reporters

This file is based on 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_COMMENT, PROPERTY_ENABLED, PROPERTY_KNOWN_STATE, PROPERTY_STATE, PROPERTY_USERNAME, QUOTED_NAME_FORMAT, UNKNOWN

Fields inherited from interface jmri.Reporter

PROPERTY_COLLECTION, PROPERTY_CURRENT_REPORT, PROPERTY_LAST_REPORT, PROPERTY_REPORT_METADATA

Constructor Summary

Constructors

Constructor	Description
AbstractIdTagReporter(String systemName)
AbstractIdTagReporter(String systemName, String userName)

Method Summary

Modifier and Type	Method	Description
String	describeState(int state)	Provide human-readable, localized version of state value.
PhysicalLocationReporter.Direction	getDirection(String rep)	Gets the direction (ENTER/EXIT) of the report.
LocoAddress	getLocoAddress(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(String s)	Get the PhysicalLocation of the Reporter.
int	getState()	Provide an integer form of the last report.
boolean	hasExitReports()	Indicates whether the underlying hardware sends messages determining when an Id is no longer in this reporter (e.g.
void	notify(IdTag id)
void	notifySeenElsewhere(IdTag tag, Reporter newReporter)	Informs this reporter that a tag previously reported here has been seen at another reporter.
void	setReport(Object r)	Provide a general method for updating the report.
void	setState(int s)	Provide generic access to internal state.

Methods inherited from class jmri.implementation.AbstractReporter

getBeanType, getCurrentReport, getLastReport, notifyCollectionUpdated

Methods inherited from class jmri.implementation.AbstractNamedBean

addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, dispose, equals, firePropertyChange, 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, getRecommendedToolTip, getSystemName, getUsageReport, getUserName, removeProperty, setComment, setProperty, setUserName, toString, updateListenerRef, vetoableChange

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Constructor Details

AbstractIdTagReporter

public AbstractIdTagReporter(String systemName)

AbstractIdTagReporter

public AbstractIdTagReporter(String systemName,
 String userName)

Method Details

hasExitReports

public boolean hasExitReports()

Indicates whether the underlying hardware sends messages determining when an Id is no longer in this reporter (e.g. RailCom block occupancy exit events).

When false (e.g. RFID point detectors), seeing a tag elsewhere implies it has departed this reporter. When true, departure is strictly governed by hardware exit/clear messages.

Returns:

true if hardware sends explicit exit/departure messages; false otherwise.

notify

public void notify(IdTag id)

Specified by:

notify in interface IdTagListener

setReport

public void setReport(Object r)

Provide a general method for updating the report.

Specified by:

setReport in interface Reporter

Overrides:

setReport in class AbstractReporter

Parameters:

r - the report

notifySeenElsewhere

public void notifySeenElsewhere(IdTag tag,
 Reporter newReporter)

Informs this reporter that a tag previously reported here has been seen at another reporter.

Default implementation is a no-op for generic reporters.

Specified by:

notifySeenElsewhere in interface Reporter

Overrides:

notifySeenElsewhere in class AbstractReporter

Parameters:

tag - the tag seen elsewhere

newReporter - the reporter where the tag was newly detected

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.

Specified by:

setState in interface NamedBean

Parameters:

s - the state

getState

public int getState()

Provide an integer form of the last report.

Specified by:

getState in interface NamedBean

Specified by:

getState in interface Reporter

Returns:

the state

describeState

@Nonnull
public 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 interface NamedBean

Overrides:

describeState in class AbstractNamedBean

Parameters:

state - the state to describe

Returns:

the state in localized form

getLocoAddress

public LocoAddress getLocoAddress(String rep)

Get the locomotive address we're reporting about from the current report.

Specified by:

getLocoAddress in interface PhysicalLocationReporter

Parameters:

rep - ignored, IdTag Reporters don't send String type reports.

getDirection

public PhysicalLocationReporter.Direction getDirection(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 interface PhysicalLocationReporter

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 interface PhysicalLocationReporter

getPhysicalLocation

public PhysicalLocation getPhysicalLocation(String s)

Get the PhysicalLocation of the Reporter.

Specified by:

getPhysicalLocation in interface PhysicalLocationReporter

Parameters:

s - unused.