Package jmri.implementation

Class AbstractRailComReporter

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractReporter

jmri.implementation.AbstractIdTagReporter

jmri.implementation.AbstractRailComReporter

All Implemented Interfaces:

Comparable<NamedBean>, PropertyChangeProvider, IdTagListener, NamedBean, PhysicalLocationReporter, Reporter

Direct Known Subclasses:

BiDiBReporter, CbusReporter, Dcc4PcReporter, Z21CanReporter, Z21Reporter

public abstract class AbstractRailComReporter
extends AbstractIdTagReporter

Extend AbstractReporter for RailCom reporters

This class is based on RfidReporter

Since:

4.5.4

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
AbstractRailComReporter(String systemName)
AbstractRailComReporter(String systemName, String userName)

Method Summary

Modifier and Type	Method	Description
LocoAddress	getLocoAddress(String rep)	Get the locomotive address we're reporting about from the current report.
abstract boolean	hasExitReports()	Indicates whether the underlying hardware sends messages determining when an Id is no longer in this reporter (e.g.

Methods inherited from class jmri.implementation.AbstractIdTagReporter

describeState, getDirection, getPhysicalLocation, getPhysicalLocation, getState, notify, notifySeenElsewhere, setReport, setState

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

AbstractRailComReporter

public AbstractRailComReporter(String systemName)

AbstractRailComReporter

public AbstractRailComReporter(String systemName,
 String userName)

Method Details

hasExitReports

public abstract 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.

Overrides:

hasExitReports in class AbstractIdTagReporter

Returns:

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

getLocoAddress

public LocoAddress getLocoAddress(String rep)

Get the locomotive address we're reporting about from the current report. Note: We ignore the string passed in, because RailCom Reporters don't send String type reports. Get the locomotive address we're reporting about from the current report.

Specified by:

getLocoAddress in interface PhysicalLocationReporter

Overrides:

getLocoAddress in class AbstractIdTagReporter

Parameters:

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