Package jmri.jmrit.logixng
Interface StringExpressionManager
-
- All Superinterfaces:
BaseManager<MaleStringExpressionSocket>
,Manager<MaleStringExpressionSocket>
,PropertyChangeProvider
,SilenceablePropertyChangeProvider
,VetoableChangeProvider
- All Known Implementing Classes:
DefaultStringExpressionManager
public interface StringExpressionManager extends BaseManager<MaleStringExpressionSocket>
Manager for Expression
-
-
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, REPORTERS, ROUTES, SECTIONS, SENSORGROUPS, SENSORS, SIGNALGROUPS, SIGNALHEADS, SIGNALMASTLOGICS, SIGNALMASTS, STRINGIOS, TIMEBASE, TRANSITS, TURNOUTS, WARRANTS
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description FemaleStringExpressionSocket
createFemaleSocket(Base parent, FemaleSocketListener listener, java.lang.String socketName)
Create a female socket for analog expressionsvoid
deleteStringExpression(MaleStringExpressionSocket x)
Delete StringExpression by removing it from the manager.java.lang.String
getAutoSystemName()
Create a new system name for an Expression.java.util.Map<Category,java.util.List<java.lang.Class<? extends Base>>>
getExpressionClasses()
Get a set of classes that implements the DigitalAction interface.default java.lang.String
getSubSystemNamePrefix()
Get the sub system prefix of this manager.MaleStringExpressionSocket
registerExpression(StringExpressionBean expression)
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 Detail
-
registerExpression
MaleStringExpressionSocket registerExpression(@Nonnull StringExpressionBean expression) throws java.lang.IllegalArgumentException
Remember a NamedBean Object created outside the manager. This method creates a MaleStringExpressionSocket for the action.- Parameters:
expression
- the bean- Returns:
- the male socket for this expression
- Throws:
java.lang.IllegalArgumentException
- if the expression has an invalid system name
-
getAutoSystemName
java.lang.String getAutoSystemName()
Create a new system name for an Expression.- Returns:
- a new system name
-
createFemaleSocket
FemaleStringExpressionSocket createFemaleSocket(Base parent, FemaleSocketListener listener, java.lang.String socketName)
Create a female socket for analog expressions- Parameters:
parent
- the parent that will own the new female socketlistener
- the listener for the female socketsocketName
- the name of the new socket- Returns:
- the new female socket
-
getExpressionClasses
java.util.Map<Category,java.util.List<java.lang.Class<? extends Base>>> getExpressionClasses()
Get a set of classes that implements the DigitalAction interface.- Returns:
- a set of entries with category and class
-
getSubSystemNamePrefix
default java.lang.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 StringExpressionManager isManager.getSystemNamePrefix()
and "SE";- Specified by:
getSubSystemNamePrefix
in interfaceManager<MaleStringExpressionSocket>
- Returns:
- the sub system prefix
-
deleteStringExpression
void deleteStringExpression(MaleStringExpressionSocket x)
Delete StringExpression by removing it from the manager. The Expression must first be deactivated so it stops processing.- Parameters:
x
- the StringExpression to delete
-
-