org.mbari.siam.foce.utils
Class ControlProtocol

java.lang.Object
  extended by org.mbari.siam.foce.utils.ControlProtocol
All Implemented Interfaces:
TCPProtocol

public class ControlProtocol
extends java.lang.Object
implements TCPProtocol


Field Summary
protected  ControlLoopConfigIF _controlLoop
           
protected static org.apache.log4j.Logger _log4j
           
protected  ProcessConfigIF _processConfig
           
static java.lang.String COMMAND_DELIMITER
           
static java.lang.String COMMAND_EXIT
           
static java.lang.String COMMAND_GETP
           
static java.lang.String COMMAND_GETS
           
static java.lang.String COMMAND_HELP
           
static java.lang.String COMMAND_PAUSE
           
static java.lang.String COMMAND_PCMODE
           
static java.lang.String COMMAND_PNAMES
           
static java.lang.String COMMAND_PRMODE
           
static java.lang.String COMMAND_QUIT
           
static java.lang.String COMMAND_RESUME
           
static java.lang.String COMMAND_SETP
           
static java.lang.String COMMAND_SNAMES
           
static java.lang.String COMMAND_START
           
static java.lang.String COMMAND_STOP
           
static java.lang.String COMMAND_VCMODE
           
static java.lang.String COMMAND_VRMODE
           
static java.lang.String MNEM_CMCONSTANT
           
static java.lang.String MNEM_CMDEADBAND
           
static java.lang.String MNEM_CMMANUAL
           
static java.lang.String MNEM_CMOFFSET
           
static java.lang.String MNEM_CONSTANT
           
static java.lang.String MNEM_DEADBAND
           
static java.lang.String MNEM_EXP
           
static java.lang.String MNEM_LIN
           
static java.lang.String MNEM_MANUAL
           
static java.lang.String MNEM_OFFSET
           
static java.lang.String MNEM_PID
           
static java.lang.String MNEM_RMEXP
           
static java.lang.String MNEM_RMLIN
           
static java.lang.String MNEM_RMPID
           
static java.lang.String MSG_DISCONNECT
           
static java.lang.String RESPONSE_ERR
           
static java.lang.String RESPONSE_OK
           
 
Constructor Summary
ControlProtocol()
           
ControlProtocol(ProcessConfigIF processConfig, ControlLoopConfigIF controlLoop)
           
 
Method Summary
 java.lang.String disconnectString()
           
 java.lang.String help()
           
 java.lang.String processInput(java.lang.String inputLine)
           
 void setSuppressStatus(boolean suppressStatus)
           
 java.util.Iterator terminators()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_log4j

protected static org.apache.log4j.Logger _log4j

COMMAND_DELIMITER

public static final java.lang.String COMMAND_DELIMITER
See Also:
Constant Field Values

COMMAND_SETP

public static final java.lang.String COMMAND_SETP
See Also:
Constant Field Values

COMMAND_GETP

public static final java.lang.String COMMAND_GETP
See Also:
Constant Field Values

COMMAND_GETS

public static final java.lang.String COMMAND_GETS
See Also:
Constant Field Values

COMMAND_PNAMES

public static final java.lang.String COMMAND_PNAMES
See Also:
Constant Field Values

COMMAND_SNAMES

public static final java.lang.String COMMAND_SNAMES
See Also:
Constant Field Values

COMMAND_PCMODE

public static final java.lang.String COMMAND_PCMODE
See Also:
Constant Field Values

COMMAND_PRMODE

public static final java.lang.String COMMAND_PRMODE
See Also:
Constant Field Values

COMMAND_VCMODE

public static final java.lang.String COMMAND_VCMODE
See Also:
Constant Field Values

COMMAND_VRMODE

public static final java.lang.String COMMAND_VRMODE
See Also:
Constant Field Values

COMMAND_HELP

public static final java.lang.String COMMAND_HELP
See Also:
Constant Field Values

COMMAND_START

public static final java.lang.String COMMAND_START
See Also:
Constant Field Values

COMMAND_STOP

public static final java.lang.String COMMAND_STOP
See Also:
Constant Field Values

COMMAND_PAUSE

public static final java.lang.String COMMAND_PAUSE
See Also:
Constant Field Values

COMMAND_RESUME

public static final java.lang.String COMMAND_RESUME
See Also:
Constant Field Values

COMMAND_QUIT

public static final java.lang.String COMMAND_QUIT
See Also:
Constant Field Values

COMMAND_EXIT

public static final java.lang.String COMMAND_EXIT
See Also:
Constant Field Values

RESPONSE_OK

public static final java.lang.String RESPONSE_OK
See Also:
Constant Field Values

RESPONSE_ERR

public static final java.lang.String RESPONSE_ERR
See Also:
Constant Field Values

MSG_DISCONNECT

public static final java.lang.String MSG_DISCONNECT
See Also:
Constant Field Values

MNEM_LIN

public static final java.lang.String MNEM_LIN
See Also:
Constant Field Values

MNEM_RMLIN

public static final java.lang.String MNEM_RMLIN
See Also:
Constant Field Values

MNEM_PID

public static final java.lang.String MNEM_PID
See Also:
Constant Field Values

MNEM_RMPID

public static final java.lang.String MNEM_RMPID
See Also:
Constant Field Values

MNEM_EXP

public static final java.lang.String MNEM_EXP
See Also:
Constant Field Values

MNEM_RMEXP

public static final java.lang.String MNEM_RMEXP
See Also:
Constant Field Values

MNEM_MANUAL

public static final java.lang.String MNEM_MANUAL
See Also:
Constant Field Values

MNEM_CMMANUAL

public static final java.lang.String MNEM_CMMANUAL
See Also:
Constant Field Values

MNEM_OFFSET

public static final java.lang.String MNEM_OFFSET
See Also:
Constant Field Values

MNEM_CMOFFSET

public static final java.lang.String MNEM_CMOFFSET
See Also:
Constant Field Values

MNEM_CONSTANT

public static final java.lang.String MNEM_CONSTANT
See Also:
Constant Field Values

MNEM_CMCONSTANT

public static final java.lang.String MNEM_CMCONSTANT
See Also:
Constant Field Values

MNEM_DEADBAND

public static final java.lang.String MNEM_DEADBAND
See Also:
Constant Field Values

MNEM_CMDEADBAND

public static final java.lang.String MNEM_CMDEADBAND
See Also:
Constant Field Values

_controlLoop

protected ControlLoopConfigIF _controlLoop

_processConfig

protected ProcessConfigIF _processConfig
Constructor Detail

ControlProtocol

public ControlProtocol(ProcessConfigIF processConfig,
                       ControlLoopConfigIF controlLoop)

ControlProtocol

public ControlProtocol()
Method Detail

setSuppressStatus

public void setSuppressStatus(boolean suppressStatus)

terminators

public java.util.Iterator terminators()
Specified by:
terminators in interface TCPProtocol

disconnectString

public java.lang.String disconnectString()
Specified by:
disconnectString in interface TCPProtocol

help

public java.lang.String help()
Specified by:
help in interface TCPProtocol

processInput

public java.lang.String processInput(java.lang.String inputLine)
                              throws java.lang.Exception
Specified by:
processInput in interface TCPProtocol
Throws:
java.lang.Exception


Copyright © 2003 MBARI.

The Monterey Bay Aquarium Research Institute (MBARI) provides this documentation and code "as is", with no warranty, express or implied, of its quality or consistency. It is provided without support and without obligation on the part of MBARI to assist in its use, correction, modification, or enhancement.