Package jmri.jmrit.logixng.expressions

Class DigitalFormula

    • Constructor Detail

      • DigitalFormula

        public DigitalFormula​(@Nonnull
                      java.lang.String sys,
                      @CheckForNull
                      java.lang.String user)
        Create a new instance of Formula with system name and user name.
        Parameters:
        sys - the system name
        user - the user name

      • DigitalFormula

        public DigitalFormula​(@Nonnull
                      java.lang.String sys,
                      @CheckForNull
                      java.lang.String user,
                      java.util.List<DigitalFormula.SocketData> expressionSystemNames)
        Create a new instance of Formula with system name and user name.
        Parameters:
        sys - the system name
        user - the user name
        expressionSystemNames - a list of system names for the expressions this formula uses

    • 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 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:
        JmriException - in case of an error

      • getFormula

        public java.lang.String getFormula()

      • 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

      • 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

      • 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

      • 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 class AbstractBase

      • getUsageDetail

        public void getUsageDetail​(int level,
                           NamedBean bean,
                           java.util.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