Package adams.scripting.command.flow

Class GetRatControlStatus

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, adams.scripting.command.RemoteCommand, adams.scripting.command.RemoteCommandOnFlow, adams.scripting.command.RemoteCommandWithErrorMessage, adams.scripting.command.RemoteCommandWithResponse, Serializable
    public class GetRatControlStatus
extends adams.scripting.command.AbstractRemoteCommandOnFlowWithResponse
    Retrieves status of Rat actors managed by RatControl actor from a running/registered flow using its ID.
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int COL_ID
      the column of the flow ID.
      static int COL_INTERACTIVE
      the column of the interactive flag.
      static int COL_PAUSABLE
      the column of the pausable flag.
      static int COL_PAUSED
      the column of the paused flag.
      static int COL_RAT
      the column of the Rat name.
      static int COL_STOPPABLE
      the column of the stoppable flag.
      static int COL_STOPPED
      the column of the stopped flag.
      protected adams.data.spreadsheet.SpreadSheet m_Status
      the status.

      • Fields inherited from class adams.scripting.command.AbstractRemoteCommandOnFlowWithResponse

        m_ID

      • Fields inherited from class adams.scripting.command.AbstractCommandWithResponse

        m_ErrorMessage, m_ResponseConnection

      • Fields inherited from class adams.scripting.command.AbstractCommand

        m_RemoteScriptingEngineHandler, m_Request

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

      • Fields inherited from interface adams.scripting.command.RemoteCommand

        KEY_COMMAND, KEY_TYPE, VALUE_REQUEST, VALUE_RESPONSE

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      byte[] getRequestPayload()
      Always zero-length array.
      Object[] getRequestPayloadObjects()
      Returns the objects that represent the request payload.
      byte[] getResponsePayload()
      Returns the payload of the response, if any.
      Object[] getResponsePayloadObjects()
      Returns the objects that represent the response payload.
      String globalInfo()
      Returns a string describing the object.
      String IDTipText()
      Returns the tip text for this property.
      protected void initialize()
      Initializes the members.
      protected void prepareResponsePayload()
      Hook method for preparing the response payload,
      void setRequestPayload​(byte[] value)
      Ignored.
      void setResponsePayload​(byte[] value)
      Sets the payload for the response.

      • Methods inherited from class adams.scripting.command.AbstractRemoteCommandOnFlowWithResponse

        defineOptions, getID, retrieveFlow, setID

      • Methods inherited from class adams.scripting.command.AbstractCommandWithResponse

        afterSendResponse, assembleResponse, assembleResponseHeader, beforeSendResponse, doHandleRequest, getDefaultResponseConnection, getErrorMessage, getResponseConnection, handleResponse, hasErrorMessage, parse, responseConnectionTipText, setResponseConnection, toString

      • Methods inherited from class adams.scripting.command.AbstractCommand

        afterSendRequest, assembleRequest, assembleRequestHeader, beforeSendRequest, getRemoteScriptingEngineHandler, handleRequest, isRequest, prepareRequestPayload, setRemoteScriptingEngineHandler, setRequest

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.Destroyable

        destroy

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

      • Methods inherited from interface adams.core.logging.LoggingSupporter

        getLogger, isLoggingEnabled

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager, toCommandLine

      • Methods inherited from interface adams.scripting.command.RemoteCommand

        afterSendRequest, assembleRequest, beforeSendRequest, getRemoteScriptingEngineHandler, handleRequest, isRequest, parse, setRemoteScriptingEngineHandler, setRequest

    • Field Detail

      • COL_PAUSABLE

        public static final int COL_PAUSABLE
        the column of the pausable flag.
        See Also:
        Constant Field Values

      • COL_PAUSED

        public static final int COL_PAUSED
        the column of the paused flag.
        See Also:
        Constant Field Values

      • COL_STOPPABLE

        public static final int COL_STOPPABLE
        the column of the stoppable flag.
        See Also:
        Constant Field Values

      • COL_STOPPED

        public static final int COL_STOPPED
        the column of the stopped flag.
        See Also:
        Constant Field Values

      • COL_INTERACTIVE

        public static final int COL_INTERACTIVE
        the column of the interactive flag.
        See Also:
        Constant Field Values

      • m_Status

        protected adams.data.spreadsheet.SpreadSheet m_Status
        the status.

    • Constructor Detail

      • GetRatControlStatus

        public GetRatControlStatus()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize in class adams.scripting.command.AbstractCommand

      • IDTipText

        public String IDTipText()
        Returns the tip text for this property.
        Specified by:
        IDTipText in interface adams.scripting.command.RemoteCommandOnFlow
        Specified by:
        IDTipText in class adams.scripting.command.AbstractRemoteCommandOnFlowWithResponse
        Returns:
        tip text for this property suitable for displaying in the gui

      • setRequestPayload

        public void setRequestPayload​(byte[] value)
        Ignored.
        Parameters:
        value - the payload

      • getRequestPayload

        public byte[] getRequestPayload()
        Always zero-length array.
        Returns:
        the payload

      • getRequestPayloadObjects

        public Object[] getRequestPayloadObjects()
        Returns the objects that represent the request payload.
        Returns:
        the objects

      • setResponsePayload

        public void setResponsePayload​(byte[] value)
        Sets the payload for the response.
        Parameters:
        value - the payload

      • getResponsePayload

        public byte[] getResponsePayload()
        Returns the payload of the response, if any.
        Returns:
        the payload

      • prepareResponsePayload

        protected void prepareResponsePayload()
        Hook method for preparing the response payload,
        Overrides:
        prepareResponsePayload in class adams.scripting.command.AbstractCommandWithResponse

      • getResponsePayloadObjects

        public Object[] getResponsePayloadObjects()
        Returns the objects that represent the response payload.
        Returns:
        the objects