Package jmri.jmrit.logixng.actions
Class ActionThrottle
- java.lang.Object
-
- jmri.implementation.AbstractNamedBean
-
- jmri.jmrit.logixng.implementation.AbstractBase
-
- jmri.jmrit.logixng.actions.AbstractDigitalAction
-
- jmri.jmrit.logixng.actions.ActionThrottle
-
- All Implemented Interfaces:
java.lang.Comparable<NamedBean>
,PropertyChangeProvider
,Base
,DigitalAction
,DigitalActionBean
,FemaleSocketListener
,NamedBean
public final class ActionThrottle extends AbstractDigitalAction implements FemaleSocketListener
Runs an engine. This action reads an analog expression with the loco address and sets its speed according to an alaog expression and the direction according to a digital expression.
-
-
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 Modifier and Type Field Description static int
LOCO_ADDRESS_SOCKET
static int
LOCO_DIRECTION_SOCKET
static int
LOCO_FUNCTION_ONOFF_SOCKET
static int
LOCO_FUNCTION_SOCKET
static int
LOCO_SPEED_SOCKET
static int
NUM_LOCO_SOCKETS
-
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 ActionThrottle(java.lang.String sys, java.lang.String user)
-
Method Summary
All 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 this DigitalActionBean.Category
getCategory()
Get the category.FemaleSocket
getChild(int index)
Get a child of this itemint
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.FemaleAnalogExpressionSocket
getLocoAddressSocket()
java.lang.String
getLocoAddressSocketSystemName()
FemaleDigitalExpressionSocket
getLocoDirectionSocket()
java.lang.String
getLocoDirectionSocketSystemName()
FemaleDigitalExpressionSocket
getLocoFunctionOnOffSocket()
java.lang.String
getLocoFunctionOnOffSocketSystemName()
FemaleAnalogExpressionSocket
getLocoFunctionSocket()
java.lang.String
getLocoFunctionSocketSystemName()
FemaleAnalogExpressionSocket
getLocoSpeedSocket()
java.lang.String
getLocoSpeedSocketSystemName()
java.lang.String
getLongDescription(java.util.Locale locale)
Get a long description of this item.SystemConnectionMemo
getMemo()
java.lang.String
getShortDescription(java.util.Locale locale)
Get a short description of this item.boolean
isStopLocoWhenSwitchingLoco()
void
registerListenersForThisClass()
Register listeners if this object needs that.void
setLocoAddressSocketSystemName(java.lang.String systemName)
void
setLocoDirectionSocketSystemName(java.lang.String systemName)
void
setLocoFunctionOnOffSocketSystemName(java.lang.String systemName)
void
setLocoFunctionSocketSystemName(java.lang.String systemName)
void
setLocoSpeedSocketSystemName(java.lang.String systemName)
void
setMemo(SystemConnectionMemo memo)
void
setStopLocoWhenSwitchingLoco(boolean value)
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, 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
-
LOCO_ADDRESS_SOCKET
public static final int LOCO_ADDRESS_SOCKET
- See Also:
- Constant Field Values
-
LOCO_SPEED_SOCKET
public static final int LOCO_SPEED_SOCKET
- See Also:
- Constant Field Values
-
LOCO_DIRECTION_SOCKET
public static final int LOCO_DIRECTION_SOCKET
- See Also:
- Constant Field Values
-
LOCO_FUNCTION_SOCKET
public static final int LOCO_FUNCTION_SOCKET
- See Also:
- Constant Field Values
-
LOCO_FUNCTION_ONOFF_SOCKET
public static final int LOCO_FUNCTION_ONOFF_SOCKET
- See Also:
- Constant Field Values
-
NUM_LOCO_SOCKETS
public static final int NUM_LOCO_SOCKETS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ActionThrottle
public ActionThrottle(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 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
-
setMemo
public void setMemo(SystemConnectionMemo memo)
-
getMemo
public SystemConnectionMemo getMemo()
-
getCategory
public Category getCategory()
Get the category.- Specified by:
getCategory
in interfaceBase
- Overrides:
getCategory
in classAbstractBase
- Returns:
- the category
-
execute
public void execute() throws JmriException
Execute this DigitalActionBean.- Specified by:
execute
in interfaceDigitalAction
- 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 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
-
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
-
getLocoAddressSocket
public FemaleAnalogExpressionSocket getLocoAddressSocket()
-
getLocoAddressSocketSystemName
public java.lang.String getLocoAddressSocketSystemName()
-
setLocoAddressSocketSystemName
public void setLocoAddressSocketSystemName(java.lang.String systemName)
-
getLocoSpeedSocket
public FemaleAnalogExpressionSocket getLocoSpeedSocket()
-
getLocoSpeedSocketSystemName
public java.lang.String getLocoSpeedSocketSystemName()
-
setLocoSpeedSocketSystemName
public void setLocoSpeedSocketSystemName(java.lang.String systemName)
-
getLocoDirectionSocket
public FemaleDigitalExpressionSocket getLocoDirectionSocket()
-
getLocoDirectionSocketSystemName
public java.lang.String getLocoDirectionSocketSystemName()
-
setLocoDirectionSocketSystemName
public void setLocoDirectionSocketSystemName(java.lang.String systemName)
-
getLocoFunctionSocket
public FemaleAnalogExpressionSocket getLocoFunctionSocket()
-
getLocoFunctionSocketSystemName
public java.lang.String getLocoFunctionSocketSystemName()
-
setLocoFunctionSocketSystemName
public void setLocoFunctionSocketSystemName(java.lang.String systemName)
-
getLocoFunctionOnOffSocket
public FemaleDigitalExpressionSocket getLocoFunctionOnOffSocket()
-
getLocoFunctionOnOffSocketSystemName
public java.lang.String getLocoFunctionOnOffSocketSystemName()
-
setLocoFunctionOnOffSocketSystemName
public void setLocoFunctionOnOffSocketSystemName(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.
-
isStopLocoWhenSwitchingLoco
public boolean isStopLocoWhenSwitchingLoco()
-
setStopLocoWhenSwitchingLoco
public void setStopLocoWhenSwitchingLoco(boolean value)
-
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
-
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 classAbstractBase
-
-