Package jmri.jmrit.logixng

Interface DigitalBooleanActionManager

All Superinterfaces:

BaseManager<MaleDigitalBooleanActionSocket>, Manager<MaleDigitalBooleanActionSocket>, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeProvider

All Known Implementing Classes:

DefaultDigitalBooleanActionManager

public interface DigitalBooleanActionManager
extends BaseManager<MaleDigitalBooleanActionSocket>

Manager for DigitalBooleanActionBean

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 inherited from interface jmri.Manager

ANALOGIOS, AUDIO, BLOCKBOSS, BLOCKS, CONDITIONALS, CTCDATA, ENTRYEXIT, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXNG_ANALOG_ACTIONS, LOGIXNG_ANALOG_EXPRESSIONS, LOGIXNG_CONDITIONALNGS, LOGIXNG_DIGITAL_ACTIONS, LOGIXNG_DIGITAL_BOOLEAN_ACTIONS, LOGIXNG_DIGITAL_EXPRESSIONS, LOGIXNG_GLOBAL_VARIABLES, LOGIXNG_MODULES, LOGIXNG_STRING_ACTIONS, LOGIXNG_STRING_EXPRESSIONS, LOGIXNG_TABLES, LOGIXNGS, LOGIXS, MEMORIES, METERFRAMES, METERS, OBLOCKS, PANELFILES, PROPERTY_BEANS, PROPERTY_CAN_DELETE, PROPERTY_DISPLAY_LIST_NAME, PROPERTY_DO_DELETE, PROPERTY_DO_NOT_DELETE, PROPERTY_LENGTH, REPORTERS, ROUTES, SECTIONS, SENSORGROUPS, SENSORS, SIGNALGROUPS, SIGNALHEADS, SIGNALMASTLOGICS, SIGNALMASTS, STRINGIOS, TIMEBASE, TRANSITS, TURNOUTS, WARRANTS

Method Summary

Modifier and Type	Method	Description
FemaleDigitalBooleanActionSocket	createFemaleSocket(Base parent, FemaleSocketListener listener, String socketName)
void	deleteDigitalBooleanAction(MaleDigitalBooleanActionSocket x)	Delete DigitalBooleanAction by removing it from the manager.
Map<Category,List<Class<? extends Base>>>	getActionClasses()	Get a set of classes that implements the DigitalBooleanActionBean interface.
String	getAutoSystemName()	Create a new system name for an DigitalBooleanActionBean.
default String	getSubSystemNamePrefix()	Get the sub system prefix of this manager.
MaleDigitalBooleanActionSocket	registerAction(DigitalBooleanActionBean action)	Remember a NamedBean Object created outside the manager.

Methods inherited from interface jmri.jmrit.logixng.BaseManager

deleteBean, getLastRegisteredMaleSocket, getMaleSocketClass, registerBean, registerMaleSocketFactory

Methods inherited from interface jmri.Manager

addDataListener, deleteBean, deregister, dispose, getBeanTypeHandled, getBeanTypeHandled, getBySystemName, getByUserName, getEntryToolTip, getKnownBeanProperties, getMemo, getNamedBean, getNamedBeanClass, getNamedBeanSet, getObjectCount, getSystemNamePrefix, getSystemPrefix, getXMLOrder, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, typeLetter, 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.beans.SilenceablePropertyChangeProvider

setPropertyChangesSilenced

Methods inherited from interface jmri.beans.VetoableChangeProvider

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Method Details

registerAction

MaleDigitalBooleanActionSocket registerAction(@Nonnull
 DigitalBooleanActionBean action)
                                       throws IllegalArgumentException

Remember a NamedBean Object created outside the manager. This method creates a MaleDigitalBooleanAction for the action.

Parameters:

action - the bean

Returns:

the male socket for this action

Throws:

IllegalArgumentException - if the action has an invalid system name

getAutoSystemName

String getAutoSystemName()

Create a new system name for an DigitalBooleanActionBean.

Returns:

a new system name

createFemaleSocket

FemaleDigitalBooleanActionSocket createFemaleSocket(Base parent,
 FemaleSocketListener listener,
 String socketName)

getActionClasses

Map<Category,List<Class<? extends Base>>> getActionClasses()

Get a set of classes that implements the DigitalBooleanActionBean interface.

Returns:

a set of entries with category and class

getSubSystemNamePrefix

default String getSubSystemNamePrefix()

Get the sub system prefix of this manager. The sub system prefix is the system name prefix and possibly some extra characters of the NamedBeans handled by this manager.

For most managers, this is the same as Manager.getSystemNamePrefix(), but for some like the managers in LogixNG, it differs. The sub system prefix for the DigitalActionManager is Manager.getSystemNamePrefix() and "DA";

Specified by:

getSubSystemNamePrefix in interface Manager<MaleDigitalBooleanActionSocket>

Returns:

the sub system prefix

deleteDigitalBooleanAction

void deleteDigitalBooleanAction(MaleDigitalBooleanActionSocket x)

Delete DigitalBooleanAction by removing it from the manager. The DigitalBooleanActionBean must first be deactivated so it stops processing.

Parameters:

x - the DigitalBooleanAction to delete