Package jmri.jmrit.logixng.util

Class NullBase

    • Method Detail

      • 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.

        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.

        Returns:
        the state

      • 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.
        Returns:
        a string of the bean type, eg Turnout, Sensor etc

      • 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

      • 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

      • getParent

        public Base getParent()
        Description copied from interface: Base
        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.
        Returns:
        the parent of this object

      • setParent

        public void setParent​(Base parent)
        Description copied from interface: Base
        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.
        Parameters:
        parent - the new parent of this object

      • setup

        public void setup()
        Description copied from interface: Base
        Setup this object and its children. This method is used to lookup system names for child sockets, turnouts, sensors, and so on.