Package jmri.jmrit.logixng.actions

Class ForEachWithDelay

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.jmrit.logixng.implementation.AbstractBase

jmri.jmrit.logixng.actions.AbstractDigitalAction

jmri.jmrit.logixng.actions.ForEachWithDelay

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.lang.Comparable<NamedBean>, java.util.EventListener, PropertyChangeProvider, Base, DigitalAction, DigitalActionBean, FemaleSocketListener, NamedBean

public class ForEachWithDelay
extends AbstractDigitalAction
implements FemaleSocketListener, java.beans.PropertyChangeListener

Executes an action when the expression is True.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ForEachWithDelay.UserSpecifiedSource

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_COMMENT, PROPERTY_ENABLED, PROPERTY_KNOWN_STATE, PROPERTY_STATE, PROPERTY_USERNAME, QUOTED_NAME_FORMAT, UNKNOWN

Constructor Summary

Constructors

Constructor	Description
ForEachWithDelay(java.lang.String sys, java.lang.String user)

Method Summary

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 this DigitalActionBean.
LogixNG_Category	getCategory()	Get the category.
FemaleSocket	getChild(int index)	Get a child of this item
int	getChildCount()	Get the number of children.
CommonManager	getCommonManager()
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.
int	getDelay()	Get the delay.
java.lang.String	getFormula()
java.lang.String	getLocalVariableName()	Get name of local variable
java.lang.String	getLongDescription(java.util.Locale locale)	Get a long description of this item.
boolean	getResetIfAlreadyStarted()	Get reset if timer is already started.
LogixNG_SelectNamedBean<Memory>	getSelectMemoryNamedBean()
LogixNG_SelectString	getSelectVariable()
java.lang.String	getShortDescription(java.util.Locale locale)	Get a short description of this item.
FemaleDigitalActionSocket	getSocket()
java.lang.String	getSocketSystemName()
TimerUnit	getUnit()	Get the unit
boolean	getUseIndividualTimers()	Get use individual timers.
ForEachWithDelay.UserSpecifiedSource	getUserSpecifiedSource()
boolean	isUseCommonSource()
void	propertyChange(java.beans.PropertyChangeEvent evt)
void	registerListenersForThisClass()	Register listeners if this object needs that.
void	setCommonManager(CommonManager commonManager)
void	setDelay(int delay)	Set the delay.
void	setFormula(java.lang.String formula)
void	setLocalVariableName(java.lang.String localVariableName)	Set name of local variable
void	setResetIfAlreadyStarted(boolean resetIfAlreadyStarted)	Set reset if timer is already started.
void	setSocketSystemName(java.lang.String systemName)
void	setUnit(TimerUnit unit)	Set the unit
void	setup()	Setup this object and its children.
void	setUseCommonSource(boolean commonSource)
void	setUseIndividualTimers(boolean useIndividualTimers)	Set reset if timer is already started.
void	setUserSpecifiedSource(ForEachWithDelay.UserSpecifiedSource userSpecifiedSource)
void	unregisterListenersForThisClass()	Unregister listeners if this object needs that.

Methods inherited from class jmri.jmrit.logixng.actions.AbstractDigitalAction

getBeanType, getNewSocketName, getNewSocketName, getParent, getPreferredSocketPrefix, getState, setParent, setState

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, existsInTree, forEntireTree, forEntireTreeWithException, getComment, getConditionalNG, getListenerRef, getListenerRefs, getListenerRefsIncludingChildren, getLogixNG, getLongDescription, getModule, getNumPropertyChangeListeners, getPropertyChangeListenersByReference, getRoot, getShortDescription, getSystemName, getUsageDetail, getUsageTree, getUserName, hasChild, isActive, isEnabled, 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, getRecommendedToolTip, 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

ForEachWithDelay

public ForEachWithDelay(java.lang.String sys,
                        java.lang.String user)

Method Detail

getDeepCopy

public Base getDeepCopy(java.util.Map<java.lang.String,java.lang.String> systemNames,
                        java.util.Map<java.lang.String,java.lang.String> userNames)
                 throws JmriException

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 interface Base

Parameters:

systemNames - a map of old and new system name

userNames - a map of old system name and new user name

Returns:

a deep copy

Throws:

JmriException - in case of an error

getSelectVariable

public LogixNG_SelectString getSelectVariable()

getSelectMemoryNamedBean

public LogixNG_SelectNamedBean<Memory> getSelectMemoryNamedBean()

setUseCommonSource

public void setUseCommonSource(boolean commonSource)

isUseCommonSource

public boolean isUseCommonSource()

setCommonManager

public void setCommonManager(CommonManager commonManager)
                      throws ParserException

Throws:

ParserException

getCommonManager

public CommonManager getCommonManager()

setUserSpecifiedSource

public void setUserSpecifiedSource(ForEachWithDelay.UserSpecifiedSource userSpecifiedSource)
                            throws ParserException

Throws:

ParserException

getUserSpecifiedSource

public ForEachWithDelay.UserSpecifiedSource getUserSpecifiedSource()

setFormula

public void setFormula(java.lang.String formula)
                throws ParserException

Throws:

ParserException

getFormula

public java.lang.String getFormula()

getDelay

public int getDelay()

Get the delay.

Returns:

the delay

setDelay

public void setDelay(int delay)

Set the delay.

Parameters:

delay - the delay

getUnit

public TimerUnit getUnit()

Get the unit

Returns:

the unit

setUnit

public void setUnit(TimerUnit unit)

Set the unit

Parameters:

unit - the unit

getLocalVariableName

public java.lang.String getLocalVariableName()

Get name of local variable

Returns:

name of local variable

setLocalVariableName

public void setLocalVariableName(java.lang.String localVariableName)

Set name of local variable

Parameters:

localVariableName - name of local variable

getResetIfAlreadyStarted

public boolean getResetIfAlreadyStarted()

Get reset if timer is already started.

Returns:

true if the timer should be reset if this action is executed while timer is ticking, false othervise

setResetIfAlreadyStarted

public void setResetIfAlreadyStarted(boolean resetIfAlreadyStarted)

Set reset if timer is already started.

Parameters:

resetIfAlreadyStarted - true if the timer should be reset if this action is executed while timer is ticking, false othervise

getUseIndividualTimers

public boolean getUseIndividualTimers()

Get use individual timers.

Returns:

true if the timer should use individual timers, false othervise

setUseIndividualTimers

public void setUseIndividualTimers(boolean useIndividualTimers)

Set reset if timer is already started.

Parameters:

useIndividualTimers - true if the timer should use individual timers, false othervise

getCategory

public LogixNG_Category getCategory()

Get the category.

Specified by:

getCategory in interface Base

Overrides:

getCategory in class AbstractBase

Returns:

the category

execute

public void execute()
             throws JmriException

Execute this DigitalActionBean.

Specified by:

execute in interface DigitalAction

Throws:

JmriException - when an exception occurs

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 interface Base

Overrides:

getChild in class AbstractBase

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 - when needed

getChildCount

public int getChildCount()

Description copied from class: AbstractBase

Get the number of children.

Specified by:

getChildCount in interface Base

Overrides:

getChildCount in class AbstractBase

Returns:

the number of children

connected

public void connected(FemaleSocket socket)

Description copied from interface: FemaleSocketListener

The socket is connected.

Specified by:

connected in interface FemaleSocketListener

Parameters:

socket - the socket

disconnected

public void disconnected(FemaleSocket socket)

Description copied from interface: FemaleSocketListener

The socket is disconnected.

Specified by:

disconnected in interface FemaleSocketListener

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 interface Base

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 interface Base

Parameters:

locale - The locale to be used

Returns:

a long description

getSocket

public FemaleDigitalActionSocket getSocket()

getSocketSystemName

public java.lang.String getSocketSystemName()

setSocketSystemName

public void setSocketSystemName(java.lang.String systemName)

setup

public void setup()

Setup this object and its children. This method is used to lookup system names for child sockets, turnouts, sensors, and so on.

Specified by:

setup in interface Base

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 class AbstractBase

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 class AbstractBase

disposeMe

public void disposeMe()

Dispose this class. Listeners do not need to be unregistered by this method since they are unregistered by dispose().

Overrides:

disposeMe in class AbstractBase

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener