Class DefaultConditionalNG
- java.lang.Object
-
- jmri.implementation.AbstractNamedBean
-
- jmri.jmrit.logixng.implementation.AbstractBase
-
- jmri.jmrit.logixng.implementation.DefaultConditionalNG
-
- All Implemented Interfaces:
java.lang.Comparable<NamedBean>
,PropertyChangeProvider
,Base
,ConditionalNG
,FemaleSocketListener
,NamedBean
public class DefaultConditionalNG extends AbstractBase implements ConditionalNG, FemaleSocketListener
The default implementation of ConditionalNG.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface jmri.jmrit.logixng.Base
Base.PrintTreeSettings, Base.RunnableWithBase, Base.RunnableWithBaseThrowException
-
Nested classes/interfaces inherited from interface jmri.NamedBean
NamedBean.BadNameException, NamedBean.BadSystemNameException, NamedBean.BadUserNameException, NamedBean.DisplayOptions, NamedBean.DuplicateSystemNameException
-
-
Field Summary
-
Fields inherited from class jmri.jmrit.logixng.implementation.AbstractBase
_listenersAreRegistered
-
Fields inherited from class jmri.implementation.AbstractNamedBean
listenerRefs, mSystemName, register
-
Fields inherited from interface jmri.jmrit.logixng.Base
PRINT_LINE_NUMBERS_FORMAT, PROPERTY_CHILD_COUNT, PROPERTY_CHILD_REORDER, PROPERTY_LAST_RESULT_CHANGED, PROPERTY_SOCKET_CONNECTED, PROPERTY_SOCKET_DISCONNECTED, SEPARATOR, SOCKET_CONNECTED, SOCKET_DISCONNECTED
-
Fields inherited from interface jmri.NamedBean
DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_STATE, QUOTED_NAME_FORMAT, UNKNOWN
-
-
Constructor Summary
Constructors Constructor Description DefaultConditionalNG(java.lang.String sys, java.lang.String user)
DefaultConditionalNG(java.lang.String sys, java.lang.String user, int threadID)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
connected(FemaleSocket socket)
The socket is connected.void
disconnected(FemaleSocket socket)
The socket is disconnected.void
disposeMe()
Dispose this class.void
execute()
Execute the ConditionalNG.void
execute(boolean allowRunDelayed)
Execute the ConditionalNG.void
execute(FemaleDigitalActionSocket socket)
Execute the female socket.static void
executeModule(Module module, java.util.Map<java.lang.String,java.lang.Object> parameters)
Executes a LogixNG Module.boolean
existsInTree()
Does this item exists in the tree?java.lang.String
getBeanType()
For instances in the code where we are dealing with just a bean and a message needs to be passed to the user or in a log.Category
getCategory()
Get the category.FemaleSocket
getChild(int index)
Get a child of this itemint
getChildCount()
Get the number of children.LogixNG_Thread
getCurrentThread()
Get the thread that this conditionalNG executes on.Base
getDeepCopy(java.util.Map<java.lang.String,java.lang.String> systemNames, java.util.Map<java.lang.String,java.lang.String> userNames)
Create a deep copy of myself and my children The item needs to try to lookup itself in both systemNames and userNames to see if the user has given a new system name and/or a new user name.If no new system name is given, an auto system name is used.FemaleDigitalActionSocket
getFemaleSocket()
Get the female socket of this ConditionalNG.java.lang.String
getLongDescription(java.util.Locale locale)
Get a long description of this item.Base
getParent()
Get the parent.boolean
getRunDelayed()
Get whenether execute() should run on the LogixNG thread at once or should dispatch the call until later.java.lang.String
getShortDescription(java.util.Locale locale)
Get a short description of this item.java.lang.String
getSocketSystemName()
Stack
getStack()
Get the stackint
getStartupThreadId()
Get the thread id that this conditionalNG should execute on when JMRI starts next time.int
getState()
Provide generic access to internal state.SymbolTable
getSymbolTable()
Get the current symbol tableboolean
isEnabled()
Determines whether this ConditionalNG is enabled.boolean
isExecuteAtStartup()
Determines whenether this ConditionalNG should be executed at startup or at panel load.boolean
isListenersRegistered()
Are listeners registered?void
registerListenersForThisClass()
Register listeners if this object needs that.void
setCurrentConditionalNG(ConditionalNG conditionalNG)
Set the current ConditionalNG.void
setEnabled(boolean enable)
Set whenether this ConditionalNG is enabled or disabled.void
setExecuteAtStartup(boolean value)
Set whenether this ConditionalNG should be executed at startup or at panel load.void
setParent(Base parent)
Set the parent.void
setRunDelayed(boolean value)
Set whenether execute() should run on the LogixNG thread at once or should dispatch the call until later.void
setSocketSystemName(java.lang.String systemName)
void
setStartupThreadId(int threadId)
Set the thread id that this conditionalNG should execute on when JMRI starts next time.void
setState(int s)
Provide generic access to internal state.void
setSymbolTable(SymbolTable symbolTable)
Set the current symbol tablevoid
setup()
Setup this object and its children.void
unregisterListenersForThisClass()
Unregister listeners if this object needs that.-
Methods inherited from class jmri.jmrit.logixng.implementation.AbstractBase
assertListenersAreNotRegistered, compareSystemNameSuffix, deepCopyChildren, dispose, getConditionalNG, getListenerRefsIncludingChildren, getLogixNG, getRoot, getUsageDetail, getUsageTree, isActive, printTree, printTree, printTree, printTreeRow, registerListeners, setParentForAllChildren, unregisterListeners
-
Methods inherited from class jmri.implementation.AbstractNamedBean
addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, describeState, equals, firePropertyChange, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, hashCode, removeProperty, removePropertyChangeListener, removePropertyChangeListener, setComment, setProperty, setUserName, toString, toStringSuffix, updateListenerRef, vetoableChange
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface jmri.jmrit.logixng.Base
addPropertyChangeListener, addPropertyChangeListener, deepCopyChildren, dispose, doSocketOperation, forEntireTree, forEntireTreeWithException, getComment, getConditionalNG, getListenerRef, getListenerRefs, getListenerRefsIncludingChildren, getLogixNG, getLongDescription, getModule, getNumPropertyChangeListeners, getPropertyChangeListenersByReference, getRoot, getShortDescription, getSystemName, getUsageDetail, getUsageTree, getUserName, hasChild, isActive, isSocketOperationAllowed, printTree, printTree, printTree, printTree, printTree, registerListeners, setComment, setParentForAllChildren, setUserName, unregisterListeners, updateListenerRef, vetoableChange
-
Methods inherited from interface jmri.jmrit.logixng.FemaleSocketListener
socketNameChanged
-
Methods inherited from interface jmri.NamedBean
addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, describeState, dispose, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUsageReport, getUserName, removeProperty, setComment, setProperty, setUserName, toString, updateListenerRef, vetoableChange
-
Methods inherited from interface jmri.beans.PropertyChangeProvider
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
-
-
-
Constructor Detail
-
DefaultConditionalNG
public DefaultConditionalNG(java.lang.String sys, java.lang.String user) throws NamedBean.BadUserNameException, NamedBean.BadSystemNameException
-
DefaultConditionalNG
public DefaultConditionalNG(java.lang.String sys, java.lang.String user, int threadID) throws NamedBean.BadUserNameException, NamedBean.BadSystemNameException
-
-
Method Detail
-
getCurrentThread
public LogixNG_Thread getCurrentThread()
Get the thread that this conditionalNG executes on.- Specified by:
getCurrentThread
in interfaceConditionalNG
- Returns:
- the thread
-
getStartupThreadId
public int getStartupThreadId()
Get the thread id that this conditionalNG should execute on when JMRI starts next time. It's not currently possible to move a ConditionalNG from one thread to another without restarting JMRI.- Specified by:
getStartupThreadId
in interfaceConditionalNG
- Returns:
- the thread ID
-
setStartupThreadId
public void setStartupThreadId(int threadId)
Set the thread id that this conditionalNG should execute on when JMRI starts next time. It's not currently possible to move a ConditionalNG from one thread to another without restarting JMRI.- Specified by:
setStartupThreadId
in interfaceConditionalNG
- Parameters:
threadId
- the thread ID
-
getParent
public Base getParent()
Get the parent.The following rules apply
- LogixNGs has no parent. The method throws an UnsupportedOperationException if called.
- Expressions and actions has the male socket that they are connected to as their parent.
- Male sockets has the female socket that they are connected to as their parent.
- The parent of a female sockets is the LogixNG, expression or action that has this female socket.
- The parent of a male sockets is the same parent as the expression or action that it contains.
-
setParent
public void setParent(Base parent)
Set the parent.The following rules apply
- ExecutionGroups has no parent. The method throws an UnsupportedOperationException if called.
- LogixNGs has the execution group as its parent.
- Expressions and actions has the male socket that they are connected to as their parent.
- Male sockets has the female socket that they are connected to as their parent.
- The parent of a female sockets is the LogixNG, expression or action that has this female socket.
- The parent of a male sockets is the same parent as the expression or action that it contains.
-
getFemaleSocket
public FemaleDigitalActionSocket getFemaleSocket()
Get the female socket of this ConditionalNG.- Specified by:
getFemaleSocket
in interfaceConditionalNG
- Returns:
- the female socket
-
setRunDelayed
public void setRunDelayed(boolean value)
Set whenether execute() should run on the LogixNG thread at once or should dispatch the call until later. Most tests turns off the delay to simplify the tests.- Specified by:
setRunDelayed
in interfaceConditionalNG
- Parameters:
value
- true if execute() should run on LogixNG thread delayed, false otherwise.
-
getRunDelayed
public boolean getRunDelayed()
Get whenether execute() should run on the LogixNG thread at once or should dispatch the call until later. Most tests turns off the delay to simplify the tests.- Specified by:
getRunDelayed
in interfaceConditionalNG
- Returns:
- true if execute() should run on LogixNG thread delayed, false otherwise.
-
execute
public void execute()
Execute the ConditionalNG.- Specified by:
execute
in interfaceConditionalNG
-
execute
public void execute(boolean allowRunDelayed)
Execute the ConditionalNG.- Specified by:
execute
in interfaceConditionalNG
- Parameters:
allowRunDelayed
- true if it's ok to run delayed, false otherwise
-
execute
public void execute(FemaleDigitalActionSocket socket)
Execute the female socket.- Specified by:
execute
in interfaceConditionalNG
- Parameters:
socket
- the female socket
-
executeModule
public static void executeModule(Module module, java.util.Map<java.lang.String,java.lang.Object> parameters) throws java.lang.IllegalArgumentException
Executes a LogixNG Module.- Parameters:
module
- The module to be executedparameters
- The parameters- Throws:
java.lang.IllegalArgumentException
-
setCurrentConditionalNG
public void setCurrentConditionalNG(ConditionalNG conditionalNG)
Set the current ConditionalNG.- Specified by:
setCurrentConditionalNG
in interfaceConditionalNG
- Parameters:
conditionalNG
- the current ConditionalNG
-
getStack
public Stack getStack()
Get the stack- Specified by:
getStack
in interfaceConditionalNG
- Returns:
- the stack
-
getSymbolTable
public SymbolTable getSymbolTable()
Get the current symbol table- Specified by:
getSymbolTable
in interfaceConditionalNG
- Returns:
- the symbol table
-
setSymbolTable
public void setSymbolTable(SymbolTable symbolTable)
Set the current symbol table- Specified by:
setSymbolTable
in interfaceConditionalNG
- Parameters:
symbolTable
- the symbol table
-
getBeanType
public java.lang.String getBeanType()
Description copied from interface:NamedBean
For instances in the code where we are dealing with just a bean and a message needs to be passed to the user or in a log.- Specified by:
getBeanType
in interfaceNamedBean
- Returns:
- a string of the bean type, eg Turnout, Sensor etc
-
setState
public void setState(int s) throws JmriException
Description copied from interface:NamedBean
Provide generic access to internal state.This generally shouldn't be used by Java code; use the class-specific form instead (e.g. setCommandedState in Turnout). This is provided to make scripts access easier to read.
- Specified by:
setState
in interfaceNamedBean
- Parameters:
s
- the state- Throws:
JmriException
- general error when setting the state fails
-
getState
public int getState()
Description copied from interface:NamedBean
Provide generic access to internal state.This generally shouldn't be used by Java code; use the class-specific form instead (e.g. getCommandedState in Turnout). This is provided to make scripts easier to read.
-
connected
public void connected(FemaleSocket socket)
Description copied from interface:FemaleSocketListener
The socket is connected.- Specified by:
connected
in interfaceFemaleSocketListener
- Parameters:
socket
- the socket
-
disconnected
public void disconnected(FemaleSocket socket)
Description copied from interface:FemaleSocketListener
The socket is disconnected.- Specified by:
disconnected
in interfaceFemaleSocketListener
- Parameters:
socket
- the socket
-
getShortDescription
public java.lang.String getShortDescription(java.util.Locale locale)
Description copied from interface:Base
Get a short description of this item.- Specified by:
getShortDescription
in interfaceBase
- Parameters:
locale
- The locale to be used- Returns:
- a short description
-
getLongDescription
public java.lang.String getLongDescription(java.util.Locale locale)
Description copied from interface:Base
Get a long description of this item.- Specified by:
getLongDescription
in interfaceBase
- Parameters:
locale
- The locale to be used- Returns:
- a long description
-
getChild
public FemaleSocket getChild(int index) throws java.lang.IllegalArgumentException, java.lang.UnsupportedOperationException
Description copied from class:AbstractBase
Get a child of this item- Specified by:
getChild
in interfaceBase
- Overrides:
getChild
in classAbstractBase
- Parameters:
index
- the index of the child to get- Returns:
- the child
- Throws:
java.lang.IllegalArgumentException
- if the index is less than 0 or greater or equal with the value returned by getChildCount()java.lang.UnsupportedOperationException
-
getChildCount
public int getChildCount()
Description copied from class:AbstractBase
Get the number of children.- Specified by:
getChildCount
in interfaceBase
- Overrides:
getChildCount
in classAbstractBase
- Returns:
- the number of children
-
getCategory
public Category getCategory()
Description copied from class:AbstractBase
Get the category.- Specified by:
getCategory
in interfaceBase
- Overrides:
getCategory
in classAbstractBase
- Returns:
- the category
-
setSocketSystemName
public void setSocketSystemName(java.lang.String systemName)
- Specified by:
setSocketSystemName
in interfaceConditionalNG
-
getSocketSystemName
public java.lang.String getSocketSystemName()
- Specified by:
getSocketSystemName
in interfaceConditionalNG
-
setup
public final void setup()
Setup this object and its children. This method is used to lookup system names for child sockets, turnouts, sensors, and so on.
-
disposeMe
public final void disposeMe()
Dispose this class. Listeners do not need to be unregistered by this method since they are unregistered by dispose().- Overrides:
disposeMe
in classAbstractBase
-
setEnabled
public void setEnabled(boolean enable)
Set whenether this ConditionalNG is enabled or disabled.This method must call registerListeners() / unregisterListeners().
- Specified by:
setEnabled
in interfaceConditionalNG
- Parameters:
enable
- true if this ConditionalNG should be enabled, false otherwise
-
isEnabled
public boolean isEnabled()
Determines whether this ConditionalNG is enabled.- Specified by:
isEnabled
in interfaceBase
- Specified by:
isEnabled
in interfaceConditionalNG
- Returns:
- true if the ConditionalNG is enabled, false otherwise
-
setExecuteAtStartup
public void setExecuteAtStartup(boolean value)
Set whenether this ConditionalNG should be executed at startup or at panel load.- Specified by:
setExecuteAtStartup
in interfaceConditionalNG
- Parameters:
value
- true if this ConditionalNG should be executed at startup or at panel load.
-
isExecuteAtStartup
public boolean isExecuteAtStartup()
Determines whenether this ConditionalNG should be executed at startup or at panel load.- Specified by:
isExecuteAtStartup
in interfaceConditionalNG
- Returns:
- true if this ConditionalNG should be executed at startup or at panel load.
-
isListenersRegistered
public boolean isListenersRegistered()
Are listeners registered?- Specified by:
isListenersRegistered
in interfaceConditionalNG
- Returns:
- true if listeners are registered, otherwise return false
-
registerListenersForThisClass
public void registerListenersForThisClass()
Register listeners if this object needs that.Important: This method may be called more than once. Methods overriding this method must ensure that listeners are not registered more than once.
- Overrides:
registerListenersForThisClass
in classAbstractBase
-
unregisterListenersForThisClass
public void unregisterListenersForThisClass()
Unregister listeners if this object needs that.Important: This method may be called more than once. Methods overriding this method must ensure that listeners are not unregistered more than once.
- Overrides:
unregisterListenersForThisClass
in classAbstractBase
-
getDeepCopy
public Base getDeepCopy(java.util.Map<java.lang.String,java.lang.String> systemNames, java.util.Map<java.lang.String,java.lang.String> userNames)
Description copied from interface:Base
Create a deep copy of myself and my children The item needs to try to lookup itself in both systemNames and userNames to see if the user has given a new system name and/or a new user name.If no new system name is given, an auto system name is used. If no user name is given, a null user name is used.- Specified by:
getDeepCopy
in interfaceBase
- Parameters:
systemNames
- a map of old and new system nameuserNames
- a map of old system name and new user name- Returns:
- a deep copy
-
existsInTree
public boolean existsInTree()
Description copied from interface:Base
Does this item exists in the tree?- Specified by:
existsInTree
in interfaceBase
- Returns:
- true if the item exists in the tree, false otherwise
-
-