Package jmri.jmrit.logixng
Interface ConditionalNG_Manager
-
- All Superinterfaces:
Manager<ConditionalNG>
,PropertyChangeProvider
,SilenceablePropertyChangeProvider
,VetoableChangeProvider
- All Known Implementing Classes:
DefaultConditionalNGManager
public interface ConditionalNG_Manager extends Manager<ConditionalNG>
Manager for ConditionalNG
-
-
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 ConditionalNG
createConditionalNG(LogixNG logixNG, java.lang.String userName)
For use with User GUI, to allow the auto generation of systemNames, where the user can optionally supply a username.ConditionalNG
createConditionalNG(LogixNG logixNG, java.lang.String userName, int threadID)
For use with User GUI, to allow the auto generation of systemNames, where the user can optionally supply a username.ConditionalNG
createConditionalNG(LogixNG logixNG, java.lang.String systemName, java.lang.String userName)
Create a new ConditionalNG if the ConditionalNG does not exist.ConditionalNG
createConditionalNG(LogixNG logixNG, java.lang.String systemName, java.lang.String userName, int threadID)
Create a new ConditionalNG if the ConditionalNG does not exist.void
deleteConditionalNG(ConditionalNG x)
Delete ConditionalNG by removing it from the manager.java.lang.String
getAutoSystemName()
Create a new system name for a ConditionalNG.ConditionalNG
getBySystemName(java.lang.String name)
Locate an existing instance based on a system name.ConditionalNG
getByUserName(java.lang.String name)
Locate an existing instance based on a user name.ConditionalNG
getByUserName(LogixNG logixNG, java.lang.String name)
Find the ConditionalNG which is a member of the LogixNG with the supplied user name.ConditionalNG
getConditionalNG(LogixNG logixNG, java.lang.String name)
Locate via user name using the LogixNG, then system name if needed.LogixNG
getParentLogixNG(java.lang.String systemName)
Find the LogixNG which has the ConditionalNG system name in its ConditionalNG_Entry list.default java.lang.String
getSubSystemNamePrefix()
Get the sub system prefix of this manager.void
setLoadDisabled(boolean s)
Support for loading ConditionalNGs in a disabled statevoid
setRunOnGUIDelayed(boolean value)
Set whenether execute() should run on the GUI thread at once or should dispatch the call until later, for all ConditionalNGs registered in this manager.-
Methods inherited from interface jmri.Manager
addDataListener, deleteBean, deregister, dispose, getBeanTypeHandled, getBeanTypeHandled, 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
-
createConditionalNG
ConditionalNG createConditionalNG(LogixNG logixNG, java.lang.String systemName, java.lang.String userName) throws java.lang.IllegalArgumentException
Create a new ConditionalNG if the ConditionalNG does not exist.- Parameters:
logixNG
- The parent LogixNGsystemName
- The system nameuserName
- The user name- Returns:
- a new ConditionalNG or null if unable to create
- Throws:
java.lang.IllegalArgumentException
-
createConditionalNG
ConditionalNG createConditionalNG(LogixNG logixNG, java.lang.String userName) throws java.lang.IllegalArgumentException
For use with User GUI, to allow the auto generation of systemNames, where the user can optionally supply a username.- Parameters:
logixNG
- The parent LogixNGuserName
- The user name- Returns:
- a new ConditionalNG or null if unable to create
- Throws:
java.lang.IllegalArgumentException
-
createConditionalNG
ConditionalNG createConditionalNG(LogixNG logixNG, java.lang.String systemName, java.lang.String userName, int threadID) throws java.lang.IllegalArgumentException
Create a new ConditionalNG if the ConditionalNG does not exist.- Parameters:
logixNG
- The parent LogixNGsystemName
- The system nameuserName
- The user namethreadID
- The thread ID that this ConditionalNG will execute on- Returns:
- a new ConditionalNG or null if unable to create
- Throws:
java.lang.IllegalArgumentException
-
createConditionalNG
ConditionalNG createConditionalNG(LogixNG logixNG, java.lang.String userName, int threadID) throws java.lang.IllegalArgumentException
For use with User GUI, to allow the auto generation of systemNames, where the user can optionally supply a username.- Parameters:
logixNG
- The parent LogixNGuserName
- The user namethreadID
- The thread ID that this ConditionalNG will execute on- Returns:
- a new ConditionalNG or null if unable to create
- Throws:
java.lang.IllegalArgumentException
-
getConditionalNG
ConditionalNG getConditionalNG(LogixNG logixNG, java.lang.String name)
Locate via user name using the LogixNG, then system name if needed. Does not create a new one if nothing found- Parameters:
logixNG
- The LogixNG for the user name match. If null, only do a system name match.name
- User name or system name to match- Returns:
- null if no match found
-
getParentLogixNG
LogixNG getParentLogixNG(java.lang.String systemName)
Find the LogixNG which has the ConditionalNG system name in its ConditionalNG_Entry list.- Parameters:
systemName
- The ConditionalNG system name.- Returns:
- the parent LogixNG or null if none found.
-
getByUserName
ConditionalNG getByUserName(LogixNG logixNG, java.lang.String name)
Find the ConditionalNG which is a member of the LogixNG with the supplied user name.- Parameters:
logixNG
- The LogixNG that contains the requested ConditionalNG.name
- The requested ConditionalNG user name.- Returns:
- the ConditionalNG or null if none found.
-
getByUserName
ConditionalNG getByUserName(java.lang.String name)
Locate an existing instance based on a user name.- Specified by:
getByUserName
in interfaceManager<ConditionalNG>
- Parameters:
name
- System Name of the required NamedBean- Returns:
- requested NamedBean object or null if none exists
-
getBySystemName
ConditionalNG getBySystemName(java.lang.String name)
Locate an existing instance based on a system name.- Specified by:
getBySystemName
in interfaceManager<ConditionalNG>
- Parameters:
name
- System Name of the required NamedBean- Returns:
- requested NamedBean object or null if none exists
-
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 ConditionalNG_Manager isManager.getSystemNamePrefix()
and "C";- Specified by:
getSubSystemNamePrefix
in interfaceManager<ConditionalNG>
- Returns:
- the sub system prefix
-
getAutoSystemName
java.lang.String getAutoSystemName()
Create a new system name for a ConditionalNG.- Returns:
- a new system name
-
deleteConditionalNG
void deleteConditionalNG(ConditionalNG x)
Delete ConditionalNG by removing it from the manager. The ConditionalNG must first be deactivated so it stops processing.- Parameters:
x
- the ConditionalNG to delete
-
setLoadDisabled
void setLoadDisabled(boolean s)
Support for loading ConditionalNGs in a disabled state- Parameters:
s
- true if ConditionalNG should be disabled when loaded
-
setRunOnGUIDelayed
void setRunOnGUIDelayed(boolean value)
Set whenether execute() should run on the GUI thread at once or should dispatch the call until later, for all ConditionalNGs registered in this manager. Most tests turns off the delay to simplify the tests.- Parameters:
value
- true if execute() should run on GUI thread delayed, false otherwise.
-
-