Package jmri.jmrix.bidib

Class BiDiBReporter

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractReporter

jmri.implementation.AbstractIdTagReporter

jmri.implementation.AbstractRailComReporter

jmri.jmrix.bidib.BiDiBReporter

All Implemented Interfaces:

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

public class BiDiBReporter
extends AbstractRailComReporter
implements BiDiBNamedBeanInterface, CollectingReporter

This class implements the Reporter Manager interface for BiDiB railcom feedback.

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

Modifier and Type	Field	Description
(package private) BiDiBAddress	addr
(package private) org.bidib.jbidibc.core.MessageListener	messageListener

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_CURRENT_REPORT, PROPERTY_LAST_REPORT

Constructor Summary

Constructors

Constructor	Description
BiDiBReporter(String systemName, BiDiBReporterManager mgr)	Create a reporter instance.

Method Summary

Modifier and Type	Method	Description
void	dispose()	Deactivate this object, so that it releases as many resources as possible and no longer effects others.
BiDiBAddress	getAddr()	Get the BiDiB address instance
Collection<Object>	getCollection()
void	nodeLost()	called then a node was lost
void	nodeNew()	called then a new node has been discovered
void	notify_loco(RailCom tag)	Notify loco address

Methods inherited from class jmri.implementation.AbstractRailComReporter

getLocoAddress

Methods inherited from class jmri.implementation.AbstractIdTagReporter

describeState, getDirection, getPhysicalLocation, getPhysicalLocation, getState, notify, setState

Methods inherited from class jmri.implementation.AbstractReporter

getBeanType, getCurrentReport, getLastReport, setReport

Methods inherited from class jmri.implementation.AbstractNamedBean

addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, 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.jmrix.bidib.BiDiBNamedBeanInterface

finishLoad

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, describeState, 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, setReport

Field Details

addr

BiDiBAddress addr

messageListener

org.bidib.jbidibc.core.MessageListener messageListener

Constructor Details

BiDiBReporter

public BiDiBReporter(String systemName,
 BiDiBReporterManager mgr)

Create a reporter instance.

Parameters:

systemName - name to be created

mgr - Reporter Manager, we get the memo object and the type letter (R) from the manager

Method Details

getAddr

public BiDiBAddress getAddr()

Get the BiDiB address instance

Specified by:

getAddr in interface BiDiBNamedBeanInterface

Returns:

BiDiBAddress

nodeNew

public void nodeNew()

called then a new node has been discovered

Specified by:

nodeNew in interface BiDiBNamedBeanInterface

nodeLost

public void nodeLost()

called then a node was lost

Specified by:

nodeLost in interface BiDiBNamedBeanInterface

notify_loco

public void notify_loco(RailCom tag)

Notify loco address

Parameters:

tag - found tag

getCollection

public Collection<Object> getCollection()

Specified by:

getCollection in interface CollectingReporter

Returns:

the collection of elements associated with this reporter.

dispose

public void dispose()

Deactivate this object, so that it releases as many resources as possible and no longer effects others.

For example, if this object has listeners, after a call to this method it should no longer notify those listeners. Any native or system-wide resources it maintains should be released, including threads, files, etc.

It is an error to invoke any other methods on this object once dispose() has been called. Note, however, that there is no guarantee about behavior in that case.

Afterwards, references to this object may still exist elsewhere, preventing its garbage collection. But it's formally dead, and shouldn't be keeping any other objects alive. Therefore, this method should null out any references to other objects that this NamedBean contained. Remove the Message Listener for this reporter

Specified by:

dispose in interface NamedBean

Overrides:

dispose in class AbstractNamedBean