org.lsst.sal

Class SALImplementation<C extends SALCommand,E extends SALEvent,T extends SALTelemetry>

java.lang.Object

org.lsst.sal.SALImplementation<C,E,T>

Type Parameters:

C - The base class for all commands sent and received by this implementation

E - The base class for all events sent and received by this implementation

T - The base class for all telemetry sent and received by this implementation

All Implemented Interfaces:

AutoCloseable, SAL<C,E,T>

Direct Known Subclasses:

ATCamera, SALCamera

public class SALImplementation<C extends SALCommand,E extends SALEvent,T extends SALTelemetry>
extends Object
implements SAL<C,E,T>

An implementation of the SAL interface which works using reflection and a description of the required interfaces using a .sal file. The .sal file contains three types of line:

• Lines beginning with #, which are treated as comments
• The first non-comment line, which is taken to be the name of the salmanager class
• All other lines, which are taken to be descriptions of SAL objects of the form:

   <type> <imple-SAL class name> <SAL class name> [<argument list>]
   

Author:

tonyj

Constructor Summary

Constructors

Modifier	Constructor and Description
	SALImplementation(BufferedReader salFile) Create a GenericSAL object by reading a .sal file.
protected	SALImplementation(Class c, String resource) Convenience method for reading configuration from a resource

Method Summary

Modifier and Type	Method and Description
void	close()
SALReceivedCommand<C>	getNextCommand(Duration timeout) Fetch the next command, or timeout if specified duration is exceeded.
E	getNextEvent(Duration timeout)
T	getTelemetry(Duration timeout)
SALCommandResponse	issueCommand(C command) Issue a command,
void	logEvent(E event) Sends an event
void	sendTelemetry(T telem)

Methods inherited from class java.lang.Object

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

Constructor Detail

SALImplementation

protected SALImplementation(Class c,
                            String resource)

Convenience method for reading configuration from a resource

Parameters:

c - The class to use to access the resource

resource - The name of the resource

SALImplementation

public SALImplementation(BufferedReader salFile)
                  throws IOException

Create a GenericSAL object by reading a .sal file.

Parameters:

salFile - A reader from which the file will be read.

Throws:

IOException - If an IO or syntax error occurs.

Method Detail

getNextCommand

public SALReceivedCommand<C> getNextCommand(Duration timeout)
                                     throws SALException

Description copied from interface: SAL

Fetch the next command, or timeout if specified duration is exceeded. After receiving a command the receiver is responsible for calling methods in returned SALReceivedCommand to acknowledge and respond to the command.

Specified by:

getNextCommand in interface SAL<C extends SALCommand,E extends SALEvent,T extends SALTelemetry>

Parameters:

timeout - The maximum time to wait before timing out

Returns:

The next command received, or null if the wait times-out.

Throws:

SALException - If a communication or similar error occurs

issueCommand

public SALCommandResponse issueCommand(C command)
                                throws SALException

Description copied from interface: SAL

Issue a command,

Specified by:

issueCommand in interface SAL<C extends SALCommand,E extends SALEvent,T extends SALTelemetry>

Parameters:

command - The command to issue.

Returns:

The CommandResponse, which can be used to obtain the response(s) from the client.

Throws:

SALException - If a communication or similar error occurs

logEvent

public void logEvent(E event)
              throws SALException

Description copied from interface: SAL

Sends an event

Specified by:

logEvent in interface SAL<C extends SALCommand,E extends SALEvent,T extends SALTelemetry>

Parameters:

event - The event to send

Throws:

SALException - If a communication or similar error occurs

getNextEvent

public E getNextEvent(Duration timeout)
               throws SALException

Specified by:

getNextEvent in interface SAL<C extends SALCommand,E extends SALEvent,T extends SALTelemetry>

Throws:

SALException

sendTelemetry

public void sendTelemetry(T telem)
                   throws SALException

Specified by:

sendTelemetry in interface SAL<C extends SALCommand,E extends SALEvent,T extends SALTelemetry>

Throws:

SALException

getTelemetry

public T getTelemetry(Duration timeout)
               throws SALException

Specified by:

getTelemetry in interface SAL<C extends SALCommand,E extends SALEvent,T extends SALTelemetry>

Throws:

SALException

close

public void close()
           throws SALException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SAL<C extends SALCommand,E extends SALEvent,T extends SALTelemetry>

Throws:

SALException