Package jmri.jmrit.logixng.expressions
Class ExpressionClock
- java.lang.Object
-
- jmri.implementation.AbstractNamedBean
-
- jmri.jmrit.logixng.implementation.AbstractBase
-
- jmri.jmrit.logixng.expressions.AbstractDigitalExpression
-
- jmri.jmrit.logixng.expressions.ExpressionClock
-
- All Implemented Interfaces:
java.beans.PropertyChangeListener,java.lang.Comparable<NamedBean>,java.util.EventListener,PropertyChangeProvider,Base,DigitalExpression,DigitalExpressionBean,NamedBean
public class ExpressionClock extends AbstractDigitalExpression implements java.beans.PropertyChangeListener
This expression is a clock.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classExpressionClock.Type-
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 (package private) java.util.TimerTasktimerTask-
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 ExpressionClock(java.lang.String sys, java.lang.String user)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddisposeMe()Dispose this class.booleanevaluate()Evaluate this expression.static java.lang.StringformatTime(int minutes)Convert minutes since midnight to hh:mm.Is_IsNot_Enumget_Is_IsNot()intgetBeginTime()LogixNG_CategorygetCategory()Get the category.FemaleSocketgetChild(int index)Get a child of this itemintgetChildCount()Get the number of children.BasegetDeepCopy(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.intgetEndTime()java.lang.StringgetLongDescription(java.util.Locale locale)Get a long description of this item.java.lang.StringgetShortDescription(java.util.Locale locale)Get a short description of this item.ExpressionClock.TypegetType()voidpropertyChange(java.beans.PropertyChangeEvent evt)voidregisterListenersForThisClass()Register listeners if this object needs that.voidset_Is_IsNot(Is_IsNot_Enum is_IsNot)voidsetRange(int beginTime, int endTime)voidsetType(ExpressionClock.Type type)voidsetup()Setup this object and its children.voidunregisterListenersForThisClass()Unregister listeners if this object needs that.-
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, 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.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
-
timerTask
java.util.TimerTask timerTask
-
-
Constructor Detail
-
ExpressionClock
public ExpressionClock(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:BaseCreate 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:
getDeepCopyin 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
- Throws:
JmriException- in case of an error
-
getCategory
public LogixNG_Category getCategory()
Get the category.- Specified by:
getCategoryin interfaceBase- Overrides:
getCategoryin classAbstractBase- Returns:
- the category
-
set_Is_IsNot
public void set_Is_IsNot(Is_IsNot_Enum is_IsNot)
-
get_Is_IsNot
public Is_IsNot_Enum get_Is_IsNot()
-
setType
public void setType(ExpressionClock.Type type)
-
getType
public ExpressionClock.Type getType()
-
setRange
public void setRange(int beginTime, int endTime)
-
getBeginTime
public int getBeginTime()
-
getEndTime
public int getEndTime()
-
formatTime
public static java.lang.String formatTime(int minutes)
Convert minutes since midnight to hh:mm.- Parameters:
minutes- The number of minutes from 0 to 1439.- Returns:
- time formatted as hh:mm.
-
evaluate
public boolean evaluate()
Evaluate this expression.- Specified by:
evaluatein interfaceDigitalExpression- Returns:
- the result of the evaluation
-
getChild
public FemaleSocket getChild(int index) throws java.lang.IllegalArgumentException, java.lang.UnsupportedOperationException
Description copied from class:AbstractBaseGet a child of this item- Specified by:
getChildin interfaceBase- Overrides:
getChildin 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- when needed
-
getChildCount
public int getChildCount()
Description copied from class:AbstractBaseGet the number of children.- Specified by:
getChildCountin interfaceBase- Overrides:
getChildCountin classAbstractBase- Returns:
- the number of children
-
getShortDescription
public java.lang.String getShortDescription(java.util.Locale locale)
Description copied from interface:BaseGet a short description of this item.- Specified by:
getShortDescriptionin 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:BaseGet a long description of this item.- Specified by:
getLongDescriptionin interfaceBase- 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.
-
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. The SystemClock listener creates a timer on the first call. Subsequent calls enabled timer processing.
- Overrides:
registerListenersForThisClassin 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. The SystemClock timer flag is set false to suspend processing of timer events. The timer keeps running for the duration of the JMRI session.
- Overrides:
unregisterListenersForThisClassin classAbstractBase
-
propertyChange
public void propertyChange(java.beans.PropertyChangeEvent evt)
- Specified by:
propertyChangein interfacejava.beans.PropertyChangeListener
-
disposeMe
public void disposeMe()
Dispose this class. Listeners do not need to be unregistered by this method since they are unregistered by dispose().- Overrides:
disposeMein classAbstractBase
-
-