Class OlcbSensor
- java.lang.Object
-
- jmri.implementation.AbstractNamedBean
-
- jmri.implementation.AbstractSensor
-
- jmri.jmrix.openlcb.OlcbSensor
-
- All Implemented Interfaces:
java.lang.Comparable<NamedBean>
,PropertyChangeProvider
,DigitalIO
,NamedBean
,Sensor
public class OlcbSensor extends AbstractSensor
Extend jmri.AbstractSensor for OpenLCB controls.
-
-
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.Sensor
Sensor.PullResistance
-
-
Field Summary
Fields Modifier and Type Field Description (package private) EventTable.EventTableEntryHolder
activeEventTableEntryHolder
(package private) OlcbAddress
addrActive
(package private) OlcbAddress
addrInactive
(package private) OlcbInterface
iface
(package private) EventTable.EventTableEntryHolder
inactiveEventTableEntryHolder
(package private) static int
ON_TIME
(package private) BitProducerConsumer
pc
(package private) VersionedValueListener<java.lang.Boolean>
sensorListener
-
Fields inherited from class jmri.implementation.AbstractSensor
_inverted, _knownState, _rawState, r, sensorDebounceGoingActive, sensorDebounceGoingInActive, thr, useDefaultTimerSettings
-
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
-
Fields inherited from interface jmri.Sensor
ACTIVE, INACTIVE, MAX_DEBOUNCE
-
-
Constructor Summary
Constructors Constructor Description OlcbSensor(java.lang.String prefix, java.lang.String address, OlcbInterface iface)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canInvert()
By default, all implementations based on this can invertint
compareSystemNameSuffix(java.lang.String suffix1, java.lang.String suffix2, NamedBean n)
Compare the suffix of this NamedBean's name with the suffix of the argument NamedBean's name for theNamedBean.compareTo(jmri.NamedBean)
operation.void
dispose()
Deactivate this object, so that it releases as many resources as possible and no longer effects others.(package private) void
finishLoad()
Helper function that will be invoked after construction once the properties have been loaded.EventID
getEventID(boolean isActive)
java.lang.String
getEventName(boolean isActive)
Computes the display name of a given event to be entered into the Event Table.boolean
isAuthoritative()
boolean
isListeningToStateMessages()
void
requestUpdateFromLayout()
Request an update on status by sending an OpenLCB message.void
setAuthoritative(boolean authoritative)
Changes how the turnout reacts to inquire state events.void
setKnownState(int s)
User request to set the state, which means that we broadcast that to all listeners by putting it out on CBUS.void
setListeningToStateMessages(boolean listen)
Changes how the turnout reacts to state declaration messages.void
setProperty(java.lang.String key, java.lang.Object value)
Attach a key/value pair to the NamedBean, which can be retrieved later.(package private) void
setTimeout()
Have sensor return to inactive after delay, used if no inactive event was specifiedvoid
setUserName(java.lang.String s)
Updates event table entries when the user name changes.-
Methods inherited from class jmri.implementation.AbstractSensor
describeState, getBeanType, getInverted, getKnownState, getPullResistance, getRawState, getReporter, getSensorDebounceGoingActiveTimer, getSensorDebounceGoingInActiveTimer, getState, getUseDefaultTimerSettings, sensorDebounce, setInverted, setOwnState, setPullResistance, setReporter, setSensorDebounceGoingActiveTimer, setSensorDebounceGoingInActiveTimer, setState, setUseDefaultTimerSettings, stateChangeCheck
-
Methods inherited from class jmri.implementation.AbstractNamedBean
addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, equals, firePropertyChange, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, hashCode, removeProperty, removePropertyChangeListener, removePropertyChangeListener, setComment, 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, compareTo, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUsageReport, getUserName, removeProperty, setComment, toString, updateListenerRef, vetoableChange
-
Methods inherited from interface jmri.beans.PropertyChangeProvider
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
Methods inherited from interface jmri.Sensor
getCommandedState, isConsistentState, setCommandedState
-
-
-
-
Field Detail
-
ON_TIME
static final int ON_TIME
- See Also:
- Constant Field Values
-
addrActive
OlcbAddress addrActive
-
addrInactive
OlcbAddress addrInactive
-
iface
final OlcbInterface iface
-
sensorListener
VersionedValueListener<java.lang.Boolean> sensorListener
-
activeEventTableEntryHolder
EventTable.EventTableEntryHolder activeEventTableEntryHolder
-
inactiveEventTableEntryHolder
EventTable.EventTableEntryHolder inactiveEventTableEntryHolder
-
-
Constructor Detail
-
OlcbSensor
public OlcbSensor(java.lang.String prefix, java.lang.String address, OlcbInterface iface)
-
-
Method Detail
-
finishLoad
void finishLoad()
Helper function that will be invoked after construction once the properties have been loaded. Used specifically for preventing double initialization when loading sensors from XML.
-
getEventName
public java.lang.String getEventName(boolean isActive)
Computes the display name of a given event to be entered into the Event Table.- Parameters:
isActive
- true for sensor active, false for inactive.- Returns:
- user-visible string to represent this event.
-
getEventID
public EventID getEventID(boolean isActive)
-
setUserName
@OverridingMethodsMustInvokeSuper public void setUserName(java.lang.String s) throws NamedBean.BadUserNameException
Updates event table entries when the user name changes.- Specified by:
setUserName
in interfaceNamedBean
- Overrides:
setUserName
in classAbstractNamedBean
- Parameters:
s
- new user name- Throws:
NamedBean.BadUserNameException
- seeNamedBean
-
requestUpdateFromLayout
public void requestUpdateFromLayout()
Request an update on status by sending an OpenLCB message.
-
setKnownState
public void setKnownState(int s)
User request to set the state, which means that we broadcast that to all listeners by putting it out on CBUS. In turn, the code in this class should use setOwnState to handle internal sets and bean notifies.- Specified by:
setKnownState
in interfaceSensor
- Overrides:
setKnownState
in classAbstractSensor
- Parameters:
s
- the state to set
-
setTimeout
void setTimeout()
Have sensor return to inactive after delay, used if no inactive event was specified
-
setAuthoritative
public void setAuthoritative(boolean authoritative)
Changes how the turnout reacts to inquire state events. With authoritative == false the state will always be reported as UNKNOWN to the layout when queried.- Parameters:
authoritative
- whether we should respond true state or unknown to the layout event state inquiries.
-
isAuthoritative
public boolean isAuthoritative()
- Returns:
- whether this producer/consumer is enabled to return state to the layout upon queries.
-
setProperty
public void setProperty(@Nonnull java.lang.String key, java.lang.Object value)
Description copied from class:AbstractNamedBean
Attach a key/value pair to the NamedBean, which can be retrieved later. These are not bound properties as yet, and don't throw events on modification. Key must not be null.Prior to JMRI 4.3, the key was of Object type. It was constrained to String to make these more like normal Java Beans.
- Specified by:
setProperty
in interfaceNamedBean
- Overrides:
setProperty
in classAbstractNamedBean
- Parameters:
key
- the property to setvalue
- the value of the property
-
isListeningToStateMessages
public boolean isListeningToStateMessages()
- Returns:
- whether this producer/consumer is always listening to state declaration messages.
-
setListeningToStateMessages
public void setListeningToStateMessages(boolean listen)
Changes how the turnout reacts to state declaration messages. With listen == true state declarations will update local state at all times. With listen == false state declarations will update local state only if local state is unknown.- Parameters:
listen
- whether we should always listen to state declaration messages.
-
canInvert
public boolean canInvert()
Description copied from class:AbstractSensor
By default, all implementations based on this can invert- Specified by:
canInvert
in interfaceSensor
- Overrides:
canInvert
in classAbstractSensor
- Returns:
- true if can be inverted; false otherwise
-
dispose
public void dispose()
Description copied from class:AbstractNamedBean
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.
-
compareSystemNameSuffix
@CheckReturnValue public int compareSystemNameSuffix(@Nonnull java.lang.String suffix1, @Nonnull java.lang.String suffix2, @Nonnull NamedBean n)
Compare the suffix of this NamedBean's name with the suffix of the argument NamedBean's name for theNamedBean.compareTo(jmri.NamedBean)
operation. This is intended to be a system-specific comparison that understands the various formats, etc. By default, does an alphanumeric-by-chunks comparison. Sorts by decoded EventID(s)- Specified by:
compareSystemNameSuffix
in interfaceNamedBean
- Overrides:
compareSystemNameSuffix
in classAbstractNamedBean
- Parameters:
suffix1
- The suffix for the 1st bean in the comparisonsuffix2
- The suffix for the 2nd bean in the comparisonn
- The other (second) NamedBean in the comparison- Returns:
- -1,0,+1 for ordering if the names are well-formed; may not provide proper ordering if the names are not well-formed.
-
-