Package jmri.jmrit.logixng.expressions

Class Timer

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.jmrit.logixng.implementation.AbstractBase

jmri.jmrit.logixng.expressions.AbstractDigitalExpression

jmri.jmrit.logixng.expressions.Timer

All Implemented Interfaces:

java.lang.Comparable<NamedBean>, PropertyChangeProvider, Base, DigitalExpression, DigitalExpressionBean, NamedBean

public class Timer
extends AbstractDigitalExpression

An expression that waits some time before returning True. This expression returns False until some time has elapsed. Then it returns True once. After that, it returns False again until some time has elapsed.

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.jmrit.logixng.DigitalExpressionBean

FALSE, TRUE

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
Timer(java.lang.String sys, java.lang.String user)

Method Summary

Modifier and Type	Method	Description
boolean	evaluate()	Evaluate this expression.
LogixNG_Category	getCategory()	Get the category.
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.
NamedBeanAddressing	getDelayAddressing()
java.lang.String	getDelayFormula()
java.lang.String	getDelayLocalVariable()
java.lang.String	getDelayReference()
java.lang.String	getLongDescription(java.util.Locale locale)	Get a long description of this item.
java.lang.String	getShortDescription(java.util.Locale locale)	Get a short description of this item.
TimerUnit	getUnit()	Get the unit
void	setDelay(int delay)	Set the delay.
void	setDelayAddressing(NamedBeanAddressing addressing)
void	setDelayFormula(java.lang.String formula)
void	setDelayLocalVariable(java.lang.String localVariable)
void	setDelayReference(java.lang.String reference)
void	setUnit(TimerUnit unit)	Set the unit
void	setup()	Setup this object and its children.

Methods inherited from class jmri.jmrit.logixng.expressions.AbstractDigitalExpression

getBeanType, getNewSocketName, getNewSocketName, getParent, getState, notifyChangedResult, setParent, setState

Methods inherited from class jmri.jmrit.logixng.implementation.AbstractBase

assertListenersAreNotRegistered, compareSystemNameSuffix, deepCopyChildren, dispose, disposeMe, getChild, getChildCount, getConditionalNG, getListenerRefsIncludingChildren, getLogixNG, getRoot, getUsageDetail, getUsageTree, isActive, printTree, printTree, printTree, printTreeRow, registerListeners, registerListenersForThisClass, setParentForAllChildren, unregisterListeners, unregisterListenersForThisClass

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, getChild, getChildCount, 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.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

Timer

public Timer(java.lang.String sys,
             java.lang.String user)
      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.

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

evaluate

public boolean evaluate()
                 throws JmriException

Evaluate this expression.

Returns:

the result of the evaluation

Throws:

JmriException - when an exception occurs

setDelayAddressing

public void setDelayAddressing(NamedBeanAddressing addressing)
                        throws ParserException

Throws:

ParserException

getDelayAddressing

public NamedBeanAddressing getDelayAddressing()

getDelay

public int getDelay()

Get the delay.

Returns:

the delay

setDelay

public void setDelay(int delay)

Set the delay.

Parameters:

delay - the delay

setDelayReference

public void setDelayReference(@Nonnull
                              java.lang.String reference)

getDelayReference

public java.lang.String getDelayReference()

setDelayLocalVariable

public void setDelayLocalVariable(@Nonnull
                                  java.lang.String localVariable)

getDelayLocalVariable

public java.lang.String getDelayLocalVariable()

setDelayFormula

public void setDelayFormula(@Nonnull
                            java.lang.String formula)
                     throws ParserException

Throws:

ParserException

getDelayFormula

public java.lang.String getDelayFormula()

getUnit

public TimerUnit getUnit()

Get the unit

Returns:

the unit

setUnit

public void setUnit(TimerUnit unit)

Set the unit

Parameters:

unit - the unit

getShortDescription

public java.lang.String getShortDescription(java.util.Locale locale)

Description copied from interface: Base

Get a short description of this item.

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.

Parameters:

locale - The locale to be used

Returns:

a long description

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.