org.lsst.sal

Class SALCommandResponse

java.lang.Object

org.lsst.sal.SALCommandResponse

public abstract class SALCommandResponse
extends Object

A command response is returned whenever a command is issued. The command response can be used to wait for the result.import static org.lsst.sal.SAL_camera.SAL__camera_ackcmd_ACTOR;

Author:

tonyj

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SALCommandResponse.CommandFailedException

Constructor Summary

Constructors

Constructor and Description
SALCommandResponse()

Method Summary

Modifier and Type	Method and Description
abstract Duration	waitForAck(Duration timeout) Wait until either an ack or nack is received, or the command completes.
abstract int	waitForCompletion(Duration timeout) Wait until the command completes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SALCommandResponse

public SALCommandResponse()

Method Detail

waitForAck

public abstract Duration waitForAck(Duration timeout)
                             throws SALCommandResponse.CommandFailedException,
                                    SALException,
                                    TimeoutException

Wait until either an ack or nack is received, or the command completes.

Parameters:

timeout - The maximum time to wait

Returns:

The expected duration of the command

Throws:

SALCommandResponse.CommandFailedException - If the command is rejected

TimeoutException - If the wait times out

SALException

waitForCompletion

public abstract int waitForCompletion(Duration timeout)
                               throws SALCommandResponse.CommandFailedException,
                                      SALException,
                                      TimeoutException

Wait until the command completes

Parameters:

timeout - The maximum time to wait

Returns:

The return code from the command

Throws:

SALCommandResponse.CommandFailedException - If the command fails or is rejected.

TimeoutException - If the wait times out

SALException