jmri.jmrix.marklin.MarklinSensorManager

All Implemented Interfaces:: PropertyChangeListener, VetoableChangeListener, EventListener, PropertyChangeFirer, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider, AbstractMRListener, MarklinListener, Manager<Sensor>, ProvidingManager<Sensor>, SensorManager

public class MarklinSensorManager
extends AbstractSensorManager
implements MarklinListener

Implement sensor manager for Marklin systems. The Manager handles all the state changes.

System names are "USnnn:yy", where U is the user configurable system prefix, nnn is the Marklin Object Number for a given s88 Bus Module and yy is the port on that module.

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.Manager
Manager.ManagerDataEvent<E extends NamedBean>, Manager.ManagerDataListener<E extends NamedBean>, Manager.NameValidity
Field Summary

Fields

Modifier and Type Field Description

(package private) MarklinTrafficController tc

Fields inherited from class jmri.managers.AbstractSensorManager
sensorDebounceGoingActive, sensorDebounceGoingInActive

Fields inherited from class jmri.managers.AbstractManager
_beans, _tsys, _tuser, memo, silenceableProperties, silencedProperties

Fields inherited from class jmri.beans.VetoableChangeSupport
vetoableChangeSupport

Fields inherited from class jmri.beans.PropertyChangeSupport
propertyChangeSupport

Fields inherited from interface jmri.Manager
ANALOGIOS, AUDIO, BLOCKBOSS, BLOCKS, CONDITIONALS, CTCDATA, deprecatedManagerLogger, ENTRYEXIT, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXNG_ANALOG_ACTIONS, LOGIXNG_ANALOG_EXPRESSIONS, LOGIXNG_CONDITIONALNGS, LOGIXNG_DIGITAL_ACTIONS, LOGIXNG_DIGITAL_BOOLEAN_ACTIONS, LOGIXNG_DIGITAL_EXPRESSIONS, LOGIXNG_STRING_ACTIONS, LOGIXNG_STRING_EXPRESSIONS, LOGIXNG_TABLES, LOGIXNGS, LOGIXS, MEMORIES, METERFRAMES, METERS, OBLOCKS, PANELFILES, REPORTERS, ROUTES, SECTIONS, SENSORGROUPS, SENSORS, SIGNALGROUPS, SIGNALHEADS, SIGNALMASTLOGICS, SIGNALMASTS, STRINGIOS, TIMEBASE, TRANSITS, TURNOUTS, WARRANTS
Constructor Summary

Constructors

Constructor Description

MarklinSensorManager(MarklinSystemConnectionMemo memo)

Method Summary

Modifier and Type	Method	Description
`boolean`	`allowMultipleAdditions(String systemName)`	Determines if it is possible to add a range of sensors in numerical order.
`Sensor`	`createNewSensor(String systemName, String userName)`	Internal method to invoke the factory and create a new Sensor based on the system name and optional user name, after all the logic for returning an existing Sensor has been invoked.
`String`	`createSystemName(String curAddress, String prefix)`	Default Sensor ensures a numeric only system name.
`MarklinSystemConnectionMemo`	`getMemo()`	Get the system connection for this manager.
`String`	`getNextValidAddress(String curAddress, String prefix, boolean ignoreInitialExisting)`	Get the Next valid hardware address.
`void`	`message(MarklinMessage m)`
`(package private) void`	`padPortNumber(int portNo, StringBuilder sb)`
`void`	`reply(MarklinReply r)`

Methods inherited from class jmri.managers.AbstractSensorManager

getBeanTypeHandled, getBySystemName, getDefaultSensorDebounceGoingActive, getDefaultSensorDebounceGoingInActive, getEntryToolTip, getNamedBeanClass, getSensor, getXMLOrder, isPullResistanceConfigurable, newSensor, provideSensor, setDefaultSensorDebounceGoingActive, setDefaultSensorDebounceGoingInActive, typeLetter, updateAll

Methods inherited from class jmri.managers.AbstractManager

addDataListener, checkNumeric, deleteBean, deregister, dispose, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getByUserName, getIncrement, getIncrementFromExistingNumber, getInstanceBySystemName, getInstanceByUserName, getKnownBeanProperties, getNamedBean, getNamedBeanList, getNamedBeanSet, getNextValidAddress, getObjectCount, getSystemNameList, getSystemPrefix, handleUserNameUniqueness, makeSystemName, propertyChange, register, registerSelf, registerUserName, removeDataListener, setDataListenerMute, setPropertyChangesSilenced, updateAutoNumber, validSystemNameFormat, vetoableChange

Methods inherited from class jmri.beans.VetoableChangeSupport

addVetoableChangeListener, addVetoableChangeListener, fireVetoableChange, fireVetoableChange, fireVetoableChange, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from class jmri.beans.PropertyChangeSupport

addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jmri.Manager

addDataListener, deleteBean, deregister, getBeanBySystemName, getBeanByUserName, getBeanTypeHandled, getKnownBeanProperties, getNamedBean, getNamedBeanList, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNameList, getSystemNamePrefix, getSystemPrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, setPropertyChangesMuted, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat, validSystemNameFormat

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface jmri.SensorManager

dispose, getByUserName, getNextValidAddress, provide

Methods inherited from interface jmri.beans.SilenceablePropertyChangeProvider

setPropertyChangesSilenced

Methods inherited from interface jmri.beans.VetoableChangeProvider

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Field Details
- tc
  
  MarklinTrafficController tc
Constructor Details
- MarklinSensorManager
  
  public MarklinSensorManager(MarklinSystemConnectionMemo memo)
Method Details
- getMemo
  
  @Nonnull public MarklinSystemConnectionMemo getMemo()
  
  Get the system connection for this manager.
  
  Specified by:
  
  getMemo in interface Manager<Sensor>
  
  Overrides:
  
  getMemo in class AbstractManager<Sensor>
  
  Returns:
  
  the system connection for this manager
- createNewSensor
  
  @Nonnull public Sensor createNewSensor(@Nonnull String systemName, String userName) throws IllegalArgumentException
  
  Internal method to invoke the factory and create a new Sensor based on the system name and optional user name, after all the logic for returning an existing Sensor has been invoked.
  System name is normalized to ensure uniqueness.
  
  Specified by:
  
  createNewSensor in class AbstractSensorManager
  
  Parameters:
  
  systemName - the system name to use for the new Sensor
  
  userName - the optional user name to use for the new Sensor
  
  Returns:
  
  the new Sensor or null if unsuccessful
  
  Throws:
  
  IllegalArgumentException - when SystemName can't be converted
- createSystemName
  
  @Nonnull public String createSystemName(@Nonnull String curAddress, @Nonnull String prefix) throws JmriException
  
  Description copied from class: AbstractSensorManager
  
  Default Sensor ensures a numeric only system name. Create a System Name from hardware address and system letter prefix. AbstractManager performs no validation.
  
  Specified by:
  
  createSystemName in interface SensorManager
  
  Overrides:
  
  createSystemName in class AbstractSensorManager
  
  Parameters:
  
  curAddress - hardware address, no system prefix or type letter.
  
  prefix - - just system prefix, not including Type Letter.
  
  Returns:
  
  full system name with system prefix, type letter and hardware address.
  
  Throws:
  
  JmriException - if unable to create a system name.
- allowMultipleAdditions
  
  public boolean allowMultipleAdditions(@Nonnull String systemName)
  
  Description copied from class: AbstractSensorManager
  
  Determines if it is possible to add a range of sensors in numerical order.
  
  Specified by:
  
  allowMultipleAdditions in interface SensorManager
  
  Overrides:
  
  allowMultipleAdditions in class AbstractSensorManager
  
  Parameters:
  
  systemName - the system name to check against; appears to be ignored in all implementations
  
  Returns:
  
  true if possible; false otherwise
- getNextValidAddress
  
  public String getNextValidAddress(@Nonnull String curAddress, @Nonnull String prefix, boolean ignoreInitialExisting) throws JmriException
  
  Description copied from class: AbstractManager
  
  Get the Next valid hardware address. Used by the Turnout / Sensor / Reporter / Light Manager classes.
  System-specific methods may want to override getIncrement() rather than this one.
  
  Specified by:
  
  getNextValidAddress in interface SensorManager
  
  Overrides:
  
  getNextValidAddress in class AbstractManager<Sensor>
  
  Parameters:
  
  curAddress - the starting hardware address to get the next valid from.
  
  prefix - system prefix, just system name, not type letter.
  
  ignoreInitialExisting - false to return the starting address if it does not exist, else true to force an increment.
  
  Returns:
  
  the next valid system name, excluding both system name prefix and type letter.
  
  Throws:
  
  JmriException - if unable to get the current / next address, or more than 10 next addresses in use.
- padPortNumber
  
  void padPortNumber(int portNo, StringBuilder sb)
- reply
  
  public void reply(MarklinReply r)
  
  Specified by:
  
  reply in interface MarklinListener
- message
  
  public void message(MarklinMessage m)
  
  Specified by:
  
  message in interface MarklinListener

Class MarklinSensorManager

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.Manager

Field Summary

Fields inherited from class jmri.managers.AbstractSensorManager

Fields inherited from class jmri.managers.AbstractManager

Fields inherited from class jmri.beans.VetoableChangeSupport

Fields inherited from class jmri.beans.PropertyChangeSupport

Fields inherited from interface jmri.Manager

Constructor Summary