Package jmri.jmrit.logixng.actions

Class ActionTimer

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.jmrit.logixng.implementation.AbstractBase

jmri.jmrit.logixng.actions.AbstractDigitalAction

jmri.jmrit.logixng.actions.ActionTimer

All Implemented Interfaces:

java.lang.Comparable<NamedBean>, PropertyChangeProvider, Base, DigitalAction, DigitalActionBean, FemaleSocketListener, NamedBean

public class ActionTimer
extends AbstractDigitalAction
implements FemaleSocketListener

Executes an action after some time.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ActionTimer.ActionData

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

Modifier and Type	Field	Description
static int	EXPRESSION_START
static int	EXPRESSION_STOP
static int	NUM_STATIC_EXPRESSIONS

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
ActionTimer(java.lang.String sys, java.lang.String user)
ActionTimer(java.lang.String sys, java.lang.String user, java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>> expressionSystemNames, java.util.List<ActionTimer.ActionData> actionDataList)

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.
FemaleDigitalActionSocket	getActionSocket(int socket)
java.lang.String	getActionSocketSystemName(int socket)
LogixNG_Category	getCategory()	Get the category.
FemaleSocket	getChild(int index)	Get a child of this item
int	getChildCount()	Get the number of children.
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(int actionSocket)	Get the delay.
java.lang.String	getDelayLocalVariablePrefix()	Is both start and stop is controlled by the start expression.
java.lang.String	getLongDescription(java.util.Locale locale)	Get a long description of this item.
int	getNumActions()
java.lang.String	getShortDescription(java.util.Locale locale)	Get a short description of this item.
FemaleDigitalExpressionSocket	getStartExpressionSocket()
java.lang.String	getStartExpressionSocketSystemName()
FemaleDigitalExpressionSocket	getStopExpressionSocket()
java.lang.String	getStopExpressionSocketSystemName()
TimerUnit	getUnit()	Get the unit
boolean	isDelayByLocalVariables()	Is delays given by local variables?
boolean	isRunContinuously()	Get if run continuously
boolean	isStartAndStopByStartExpression()	Is both start and stop is controlled by the start expression.
boolean	isStartImmediately()	Get if to start immediately
void	registerListenersForThisClass()	Register listeners if this object needs that.
void	setActionSocketSystemName(int socket, java.lang.String systemName)
void	setDelay(int actionSocket, int delay)	Set the delay.
void	setDelayByLocalVariables(boolean value)	Set if delays should be given by local variables.
void	setDelayLocalVariablePrefix(java.lang.String value)	Set if both start and stop is controlled by the start expression.
void	setNumActions(int num)
void	setRunContinuously(boolean runContinuously)	Set if run continuously
void	setStartAndStopByStartExpression(boolean startAndStopByStartExpression)	Set if both start and stop is controlled by the start expression.
void	setStartExpressionSocketSystemName(java.lang.String systemName)
void	setStartImmediately(boolean startImmediately)	Set if to start immediately
void	setStopExpressionSocketSystemName(java.lang.String systemName)
void	setUnit(TimerUnit unit)	Set the unit
void	setup()	Setup this object and its children.
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

Field Detail

EXPRESSION_START

public static final int EXPRESSION_START

See Also:

Constant Field Values

EXPRESSION_STOP

public static final int EXPRESSION_STOP

See Also:

Constant Field Values

NUM_STATIC_EXPRESSIONS

public static final int NUM_STATIC_EXPRESSIONS

See Also:

Constant Field Values

Constructor Detail

ActionTimer

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

ActionTimer

public ActionTimer(java.lang.String sys,
                   java.lang.String user,
                   java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>> expressionSystemNames,
                   java.util.List<ActionTimer.ActionData> actionDataList)
            throws NamedBean.BadUserNameException,
                   NamedBean.BadSystemNameException

Throws:

NamedBean.BadUserNameException

NamedBean.BadSystemNameException

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

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

getDelay

public int getDelay(int actionSocket)

Get the delay.

Parameters:

actionSocket - the socket

Returns:

the delay

setDelay

public void setDelay(int actionSocket,
                     int delay)

Set the delay.

Parameters:

actionSocket - the socket

delay - the delay

isStartImmediately

public boolean isStartImmediately()

Get if to start immediately

Returns:

true if to start immediately

setStartImmediately

public void setStartImmediately(boolean startImmediately)

Set if to start immediately

Parameters:

startImmediately - true if to start immediately

isRunContinuously

public boolean isRunContinuously()

Get if run continuously

Returns:

true if run continuously

setRunContinuously

public void setRunContinuously(boolean runContinuously)

Set if run continuously

Parameters:

runContinuously - true if run continuously

isStartAndStopByStartExpression

public boolean isStartAndStopByStartExpression()

Is both start and stop is controlled by the start expression.

Returns:

true if to start immediately

setStartAndStopByStartExpression

public void setStartAndStopByStartExpression(boolean startAndStopByStartExpression)

Set if both start and stop is controlled by the start expression.

Parameters:

startAndStopByStartExpression - true if to start immediately

getUnit

public TimerUnit getUnit()

Get the unit

Returns:

the unit

setUnit

public void setUnit(TimerUnit unit)

Set the unit

Parameters:

unit - the unit

isDelayByLocalVariables

public boolean isDelayByLocalVariables()

Is delays given by local variables?

Returns:

value true if delay is given by local variables

setDelayByLocalVariables

public void setDelayByLocalVariables(boolean value)

Set if delays should be given by local variables.

Parameters:

value - true if delay is given by local variables

getDelayLocalVariablePrefix

public java.lang.String getDelayLocalVariablePrefix()

Is both start and stop is controlled by the start expression.

Returns:

true if to start immediately

setDelayLocalVariablePrefix

public void setDelayLocalVariablePrefix(java.lang.String value)

Set if both start and stop is controlled by the start expression.

Parameters:

value - true if to start immediately

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

getStartExpressionSocket

public FemaleDigitalExpressionSocket getStartExpressionSocket()

getStartExpressionSocketSystemName

public java.lang.String getStartExpressionSocketSystemName()

setStartExpressionSocketSystemName

public void setStartExpressionSocketSystemName(java.lang.String systemName)

getStopExpressionSocket

public FemaleDigitalExpressionSocket getStopExpressionSocket()

getStopExpressionSocketSystemName

public java.lang.String getStopExpressionSocketSystemName()

setStopExpressionSocketSystemName

public void setStopExpressionSocketSystemName(java.lang.String systemName)

getNumActions

public int getNumActions()

setNumActions

public void setNumActions(int num)

getActionSocket

public FemaleDigitalActionSocket getActionSocket(int socket)

getActionSocketSystemName

public java.lang.String getActionSocketSystemName(int socket)

setActionSocketSystemName

public void setActionSocketSystemName(int socket,
                                      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