Class UpdateVariable

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractActorTemplate>, SizeOfHandler, Serializable

    public class UpdateVariable
    extends AbstractActorTemplate
    Generates a sub-flow (enlosed by a Trigger) that retrieves and sets a variable, with the user being able to add custom actors in between for updating the variable value.

    Valid options are:

    -D <int> (property: debugLevel)
        The greater the number the more additional info the scheme may output to
        the console (0 = off).
        default: 0
        minimum: 0
    -name <java.lang.String> (property: name)
        The new name for the actor; leave empty to use current.
    -variable <adams.core.VariableName> (property: variableName)
        The variable to generate the sub-flow for.
        default: variable
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_VariableName

        protected VariableName m_VariableName
        the variable to update.
    • Constructor Detail

      • UpdateVariable

        public UpdateVariable()
    • Method Detail

      • setVariableName

        public void setVariableName​(VariableName value)
        Sets the variable name to generate the sub-flow for.
        value - the variable
      • getVariableName

        public VariableName getVariableName()
        Returns the variable name to generate the sub-flow for.
        the variable
      • variableNameTipText

        public String variableNameTipText()
        Returns the tip text for this property.
        tip text for this property suitable for displaying in the gui
      • isInteractive

        public boolean isInteractive()
        Whether the flow generated is an interactive one.
        Specified by:
        isInteractive in class AbstractActorTemplate
        true if interactive