Package jmri.jmrit.logixng.actions

Class ActionEntryExit

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.jmrit.logixng.implementation.AbstractBase

jmri.jmrit.logixng.actions.AbstractDigitalAction

jmri.jmrit.logixng.actions.ActionEntryExit

All Implemented Interfaces:

VetoableChangeListener, Comparable<NamedBean>, EventListener, PropertyChangeProvider, Base, DigitalAction, DigitalActionBean, NamedBean

public class ActionEntryExit
extends AbstractDigitalAction
implements VetoableChangeListener

This action triggers a entryExit.

This action has the Operation enum, similar to EnableLogix and other actions, despite that's not needed since this action only has one option. But it's here in case someone wants to add more options later.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ActionEntryExit.Operation

Nested classes/interfaces inherited from interface jmri.jmrit.logixng.Base

Base.PrintTreeSettings, Base.RunnableWithBase

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, 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
ActionEntryExit(String sys, String user)

Method Summary

Modifier and Type	Method	Description
void	disposeMe()	Dispose this class.
void	execute()	Execute this DigitalActionBean.
NamedBeanAddressing	getAddressing()
Category	getCategory()	Get the category.
FemaleSocket	getChild(int index)	Get a child of this item
int	getChildCount()	Get the number of children.
Base	getDeepCopy(Map<String,String> systemNames, Map<String,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.
NamedBeanHandle<DestinationPoints>	getDestinationPoints()
String	getFormula()
String	getLocalVariable()
String	getLockFormula()
String	getLongDescription(Locale locale)	Get a long description of this item.
NamedBeanAddressing	getOperationAddressing()
ActionEntryExit.Operation	getOperationDirect()
String	getOperationLocalVariable()
String	getOperationReference()
String	getReference()
String	getShortDescription(Locale locale)	Get a short description of this item.
void	getUsageDetail(int level, NamedBean bean, List<NamedBeanUsageReport> report, NamedBean cdl)	Add a new NamedBeanUsageReport to the report list if there are any matches in this action or expresssion.
boolean	isExternal()	Is this external?
void	registerListenersForThisClass()	Register listeners if this object needs that.
void	removeDestinationPoints()
void	setAddressing(NamedBeanAddressing addressing)
void	setDestinationPoints(String entryExitName)
void	setDestinationPoints(DestinationPoints entryExit)
void	setDestinationPoints(NamedBeanHandle<DestinationPoints> handle)
void	setFormula(String formula)
void	setLocalVariable(String localVariable)
void	setOperationAddressing(NamedBeanAddressing addressing)
void	setOperationDirect(ActionEntryExit.Operation state)
void	setOperationFormula(String formula)
void	setOperationLocalVariable(String localVariable)
void	setOperationReference(String reference)
void	setReference(String reference)
void	setup()	Setup this object and its children.
void	unregisterListenersForThisClass()	Unregister listeners if this object needs that.
void	vetoableChange(PropertyChangeEvent evt)

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

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

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

assertListenersAreNotRegistered, compareSystemNameSuffix, deepCopyChildren, dispose, getConditionalNG, getLogixNG, getRoot, 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, getFullyFormattedDisplayName, getFullyFormattedDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, hashCode, removeProperty, removePropertyChangeListener, removePropertyChangeListener, setComment, setProperty, setUserName, toString, toStringSuffix, updateListenerRef

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, forEntireTree, getComment, getConditionalNG, getListenerRef, getListenerRefs, getLogixNG, getLongDescription, getNumPropertyChangeListeners, getPropertyChangeListenersByReference, getRoot, getShortDescription, getSystemName, getUsageTree, getUserName, isActive, isEnabled, isSocketOperationAllowed, printTree, printTree, printTree, printTree, printTree, registerListeners, setComment, setParentForAllChildren, setUserName, unregisterListeners, updateListenerRef

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, describeState, dispose, getComment, getDisplayName, getDisplayName, getFullyFormattedDisplayName, getFullyFormattedDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUsageReport, getUserName, removeProperty, setComment, setProperty, setUserName, toString, updateListenerRef

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Constructor Details

ActionEntryExit

public ActionEntryExit(String sys, String user) throws NamedBean.BadUserNameException, NamedBean.BadSystemNameException

Throws:

NamedBean.BadUserNameException

NamedBean.BadSystemNameException

Method Details

getDeepCopy

public Base getDeepCopy(Map<String,String> systemNames, Map<String,String> userNames) throws ParserException

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:

ParserException

setDestinationPoints

public void setDestinationPoints(@Nonnull String entryExitName)

setDestinationPoints

public void setDestinationPoints(@Nonnull NamedBeanHandle<DestinationPoints> handle)

setDestinationPoints

public void setDestinationPoints(@Nonnull DestinationPoints entryExit)

removeDestinationPoints

public void removeDestinationPoints()

getDestinationPoints

public NamedBeanHandle<DestinationPoints> getDestinationPoints()

setAddressing

public void setAddressing(NamedBeanAddressing addressing) throws ParserException

Throws:

ParserException

getAddressing

public NamedBeanAddressing getAddressing()

setReference

public void setReference(@Nonnull String reference)

getReference

public String getReference()

setLocalVariable

public void setLocalVariable(@Nonnull String localVariable)

getLocalVariable

public String getLocalVariable()

setFormula

public void setFormula(@Nonnull String formula) throws ParserException

Throws:

ParserException

getFormula

public String getFormula()

setOperationAddressing

public void setOperationAddressing(NamedBeanAddressing addressing) throws ParserException

Throws:

ParserException

getOperationAddressing

public NamedBeanAddressing getOperationAddressing()

setOperationDirect

public void setOperationDirect(ActionEntryExit.Operation state)

getOperationDirect

public ActionEntryExit.Operation getOperationDirect()

setOperationReference

public void setOperationReference(@Nonnull String reference)

getOperationReference

public String getOperationReference()

setOperationLocalVariable

public void setOperationLocalVariable(@Nonnull String localVariable)

getOperationLocalVariable

public String getOperationLocalVariable()

setOperationFormula

public void setOperationFormula(@Nonnull String formula) throws ParserException

Throws:

ParserException

getLockFormula

public String getLockFormula()

vetoableChange

public void vetoableChange(PropertyChangeEvent evt) throws PropertyVetoException

Specified by:

vetoableChange in interface Base

Specified by:

vetoableChange in interface NamedBean

Specified by:

vetoableChange in interface VetoableChangeListener

Overrides:

vetoableChange in class AbstractNamedBean

Throws:

PropertyVetoException

getCategory

public Category getCategory()

Get the category.

Specified by:

getCategory in interface Base

Returns:

the category

isExternal

public boolean isExternal()

Is this external? Does it affects or is dependent on external things, like turnouts and sensors? Timers are considered as internal since they behavies the same on every computer on every layout.

Specified by:

isExternal in interface Base

Returns:

true if this is external

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 IllegalArgumentException, UnsupportedOperationException

Description copied from interface: Base

Get a child of this item

Specified by:

getChild in interface Base

Parameters:

index - the index of the child to get

Returns:

the child

Throws:

IllegalArgumentException - if the index is less than 0 or greater or equal with the value returned by getChildCount()

UnsupportedOperationException

getChildCount

public int getChildCount()

Description copied from interface: Base

Get the number of children.

Specified by:

getChildCount in interface Base

Returns:

the number of children

getShortDescription

public String getShortDescription(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 String getLongDescription(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

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.

Specified by:

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.

Specified by:

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().

Specified by:

disposeMe in class AbstractBase

getUsageDetail

public void getUsageDetail(int level, NamedBean bean, List<NamedBeanUsageReport> report, NamedBean cdl)

Add a new NamedBeanUsageReport to the report list if there are any matches in this action or expresssion.

NamedBeanUsageReport Usage keys:

• LogixNGAction
• LogixNGExpression

Specified by:

getUsageDetail in interface Base

Overrides:

getUsageDetail in class AbstractBase

Parameters:

level - The current recursion level for debugging.

bean - The named bean that is the object of the search.

report - A list of NamedBeanUsageReport usage reports.

cdl - The current ConditionalNG bean. Null for Module searches since there is no conditional