Package jmri.jmrix.roco.z21

Class Z21CanReporter

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractReporter

jmri.implementation.AbstractIdTagReporter

jmri.implementation.AbstractRailComReporter

jmri.jmrix.roco.z21.Z21CanReporter

All Implemented Interfaces:

Comparable<NamedBean>, EventListener, PropertyChangeProvider, CollectingReporter, IdTagListener, AbstractMRListener, Z21Listener, NamedBean, PhysicalLocationReporter, Reporter

public class Z21CanReporter
extends AbstractRailComReporter
implements Z21Listener, CollectingReporter

Z21CanReporter implements the Reporter Manager interface for Can connected reporters on Roco Z21 systems.

Reports from this reporter are of the type jmri.RailCom.

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
Z21CanReporter(String systemName, String userName, Z21SystemConnectionMemo memo)	Create a new Z21CanReporter.

Method Summary

Modifier and Type	Method	Description
Collection<Object>	getCollection()
boolean	hasExitReports()	Indicates whether the underlying hardware sends messages determining when an Id is no longer in this reporter (e.g.
void	message(Z21Message msg)	Member function that will be invoked by a z21Interface implementation to forward a z21 message sent to the layout.
void	reply(Z21Reply msg)	Member function that will be invoked by a z21Interface implementation to forward a z21 message from the layout.

Methods inherited from class jmri.implementation.AbstractRailComReporter

getLocoAddress

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, describeState, dispose, getBeanType, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getRecommendedToolTip, getSystemName, getUsageReport, getUserName, removeProperty, setComment, setProperty, setState, setUserName, toString, updateListenerRef, vetoableChange

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface jmri.Reporter

getCurrentReport, getLastReport, getState, notifySeenElsewhere, setReport

Constructor Details

Z21CanReporter

public Z21CanReporter(String systemName,
 String userName,
 Z21SystemConnectionMemo memo)

Create a new Z21CanReporter.

Parameters:

systemName - the system name of the new reporter.

userName - the user name of the new reporter.

memo - an instance of Z21SystemConnectionMemo this reporter is associated with.

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.

Specified by:

hasExitReports in class AbstractRailComReporter

Returns:

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

reply

public void reply(Z21Reply msg)

Member function that will be invoked by a z21Interface implementation to forward a z21 message from the layout.

Specified by:

reply in interface Z21Listener

Parameters:

msg - The received z21 reply. Note that this same object may be presented to multiple users. It should not be modified here.

message

public void message(Z21Message msg)

Member function that will be invoked by a z21Interface implementation to forward a z21 message sent to the layout. Normally, this function will do nothing.

Specified by:

message in interface Z21Listener

Parameters:

msg - The received z21 message. Note that this same object may be presented to multiple users. It should not be modified here.

getCollection

public Collection<Object> getCollection()

Specified by:

getCollection in interface CollectingReporter

Returns:

the collection of elements associated with this reporter.