jmri
Interface RailComManager

Show UML class diagram

All Superinterfaces:

IdTagManager, Manager

All Known Implementing Classes:

DefaultRailComManager

public interface RailComManager
extends IdTagManager

Locate a RailCom Object representing a specific RailCom Enabled device.
RailCom is a registered trademark of Lenz GmbH.

RailCom objects are obtained from an RailComManager, which in turn is generally located from the InstanceManager. A typical call sequence might be:

 RailCom rc = InstanceManager.getDefault(jmri.RailComManager.class).provideIdTag("23");

The RailCom Manager itself is not installed unless the required hardware that supports RailCom has been installed.

Although the RailCom object does extend the NamedBean, it doesn't specifically use the system or user names as each RailCom device should in itself be unique.

Since:

2.99.4

Field Summary

Fields inherited from interface jmri.Manager

AUDIO, BLOCKBOSS, BLOCKS, CONDITIONALS, ENTRYEXIT, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXS, MEMORIES, OBLOCKS, PANELFILES, REPORTERS, ROUTES, SECTIONS, SENSORGROUPS, SENSORS, SIGNALGROUPS, SIGNALHEADS, SIGNALMASTLOGICS, SIGNALMASTS, TIMEBASE, TRANSITS, TURNOUTS, WARRANTS

Method Summary

RailCom	getIdTag(String name) Locate via tag ID, then by user name, and finally system name if needed.
RailCom	provideIdTag(String name) Locate via tag ID, then user name, and finally system name if needed.

Methods inherited from interface jmri.IdTagManager

getBySystemName, getByTagID, getByUserName, getSystemNameList, getTagsForReporter, init, isFastClockUsed, isInitialised, isStateStored, newIdTag, setFastClockUsed, setStateStored

Methods inherited from interface jmri.Manager

addPropertyChangeListener, deregister, dispose, getBeanBySystemName, getBeanByUserName, getNamedBean, getNamedBeanList, getSystemNameArray, getSystemPrefix, getXMLOrder, makeSystemName, register, removePropertyChangeListener, systemLetter, typeLetter

Method Detail

provideIdTag

RailCom provideIdTag(String name)

Description copied from interface: IdTagManager

Locate via tag ID, then user name, and finally system name if needed. If that fails, create a new IdTag. If the name is a valid system name, it will be used for the new IdTag. Otherwise, the makeSystemName method will attempt to turn it into a valid system name.

Specified by:

provideIdTag in interface IdTagManager

Parameters:

name - Tag ID, user name, system name, or address which can be promoted to system name

Returns:

Never null

getIdTag

RailCom getIdTag(String name)

Description copied from interface: IdTagManager

Locate via tag ID, then by user name, and finally system name if needed. If that fails, return null

Specified by:

getIdTag in interface IdTagManager

Parameters:

name - tag name being requested

Returns:

null if no match found