Package jmri.jmrit.logixng.implementation

Class DefaultConditionalNG

    • Method Detail

      • getStartupThreadId

        public int getStartupThreadId()
        Get the thread id that this conditionalNG should execute on when JMRI starts next time. It's not currently possible to move a ConditionalNG from one thread to another without restarting JMRI.
        Specified by:
        getStartupThreadId in interface ConditionalNG
        Returns:
        the thread ID

      • setStartupThreadId

        public void setStartupThreadId​(int threadId)
        Set the thread id that this conditionalNG should execute on when JMRI starts next time. It's not currently possible to move a ConditionalNG from one thread to another without restarting JMRI.
        Specified by:
        setStartupThreadId in interface ConditionalNG
        Parameters:
        threadId - the thread ID

      • getParent

        public Base getParent()
        Get the parent.

        The following rules apply

        • LogixNGs has no parent. The method throws an UnsupportedOperationException if called.
        • Expressions and actions has the male socket that they are connected to as their parent.
        • Male sockets has the female socket that they are connected to as their parent.
        • The parent of a female sockets is the LogixNG, expression or action that has this female socket.
        • The parent of a male sockets is the same parent as the expression or action that it contains.
        Specified by:
        getParent in interface Base
        Returns:
        the parent of this object

      • setParent

        public void setParent​(Base parent)
        Set the parent.

        The following rules apply

        • ExecutionGroups has no parent. The method throws an UnsupportedOperationException if called.
        • LogixNGs has the execution group as its parent.
        • Expressions and actions has the male socket that they are connected to as their parent.
        • Male sockets has the female socket that they are connected to as their parent.
        • The parent of a female sockets is the LogixNG, expression or action that has this female socket.
        • The parent of a male sockets is the same parent as the expression or action that it contains.
        Specified by:
        setParent in interface Base
        Parameters:
        parent - the new parent of this object

      • setRunDelayed

        public void setRunDelayed​(boolean value)
        Set whenether execute() should run on the LogixNG thread at once or should dispatch the call until later. Most tests turns off the delay to simplify the tests.
        Specified by:
        setRunDelayed in interface ConditionalNG
        Parameters:
        value - true if execute() should run on LogixNG thread delayed, false otherwise.

      • getRunDelayed

        public boolean getRunDelayed()
        Get whenether execute() should run on the LogixNG thread at once or should dispatch the call until later. Most tests turns off the delay to simplify the tests.
        Specified by:
        getRunDelayed in interface ConditionalNG
        Returns:
        true if execute() should run on LogixNG thread delayed, false otherwise.

      • execute

        public void execute​(boolean allowRunDelayed)
        Execute the ConditionalNG.
        Specified by:
        execute in interface ConditionalNG
        Parameters:
        allowRunDelayed - true if it's ok to run delayed, false otherwise

      • executeModule

        public static void executeModule​(Module module,
                                 java.util.Map<java.lang.String,​java.lang.Object> parameters)
                          throws java.lang.IllegalArgumentException
        Executes a LogixNG Module.
        Parameters:
        module - The module to be executed
        parameters - The parameters
        Throws:
        java.lang.IllegalArgumentException - when needed

      • getBeanType

        public java.lang.String getBeanType()
        Description copied from interface: NamedBean
        For instances in the code where we are dealing with just a bean and a message needs to be passed to the user or in a log.
        Specified by:
        getBeanType in interface NamedBean
        Returns:
        a string of the bean type, eg Turnout, Sensor etc

      • setState

        public void setState​(int s)
              throws JmriException
        Description copied from interface: NamedBean
        Provide generic access to internal state.

        This generally shouldn't be used by Java code; use the class-specific form instead (e.g. setCommandedState in Turnout). This is provided to make scripts access easier to read.

        Specified by:
        setState in interface NamedBean
        Parameters:
        s - the state
        Throws:
        JmriException - general error when setting the state fails

      • getState

        public int getState()
        Description copied from interface: NamedBean
        Provide generic access to internal state.

        This generally shouldn't be used by Java code; use the class-specific form instead (e.g. getCommandedState in Turnout). This is provided to make scripts easier to read.

        Specified by:
        getState in interface NamedBean
        Returns:
        the state

      • 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

      • 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

      • setup

        public final 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

      • disposeMe

        public final 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

      • setEnabled

        public void setEnabled​(boolean enable)
        Set whenether this ConditionalNG is enabled or disabled.

        This method must call registerListeners() / unregisterListeners().

        Specified by:
        setEnabled in interface ConditionalNG
        Parameters:
        enable - true if this ConditionalNG should be enabled, false otherwise

      • isEnabled

        public boolean isEnabled()
        Determines whether this ConditionalNG is enabled.
        Specified by:
        isEnabled in interface Base
        Specified by:
        isEnabled in interface ConditionalNG
        Returns:
        true if the ConditionalNG is enabled, false otherwise

      • setExecuteAtStartup

        public void setExecuteAtStartup​(boolean value)
        Set whenether this ConditionalNG should be executed at startup or at panel load.
        Specified by:
        setExecuteAtStartup in interface ConditionalNG
        Parameters:
        value - true if this ConditionalNG should be executed at startup or at panel load.

      • isExecuteAtStartup

        public boolean isExecuteAtStartup()
        Determines whenether this ConditionalNG should be executed at startup or at panel load.
        Specified by:
        isExecuteAtStartup in interface ConditionalNG
        Returns:
        true if this ConditionalNG should be executed at startup or at panel load.

      • getDeepCopy

        public Base getDeepCopy​(java.util.Map<java.lang.String,​java.lang.String> systemNames,
                        java.util.Map<java.lang.String,​java.lang.String> userNames)
        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

      • existsInTree

        public boolean existsInTree()
        Description copied from interface: Base
        Does this item exists in the tree?
        Specified by:
        existsInTree in interface Base
        Returns:
        true if the item exists in the tree, false otherwise