Package adams.flow.source

Class NewRemoteCommand

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, OutputProducer, Serializable, Comparable
    public class NewRemoteCommand
extends AbstractSimpleSource
    Configures and forwards a remote command.

    Input/output:
    - generates:
       adams.scripting.command.RemoteCommand


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: NewRemoteCommand
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing 
    actor handler must have this enabled as well.
    default: false
 
    -command <adams.scripting.command.RemoteCommand> (property: command)
    The command to create.
    default: adams.scripting.command.basic.SystemInfo -response-connection adams.scripting.connection.DefaultConnection
 
    -request <boolean> (property: request)
    If enabled, a request instead of a response is created.
    default: true
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Command

        protected RemoteCommand m_Command
        the command to create.

      • m_Request

        protected boolean m_Request
        whether to create a request or response.

    • Constructor Detail

      • NewRemoteCommand

        public NewRemoteCommand()

    • Method Detail

      • setCommand

        public void setCommand​(RemoteCommand value)
        Sets the command to create.
        Parameters:
        value - the command

      • getCommand

        public RemoteCommand getCommand()
        Returns the command to create.
        Returns:
        the command

      • commandTipText

        public String commandTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setRequest

        public void setRequest​(boolean value)
        Sets whether to create a request or response.
        Parameters:
        value - true if to create a request

      • getRequest

        public boolean getRequest()
        Returns whether to create a request or response.
        Returns:
        true if to create a request

      • requestTipText

        public String requestTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the Class of the generated tokens

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message