org.lsst.ccs.utilities.image.samp

Class SampUtils

java.lang.Object

org.lsst.ccs.utilities.image.samp.SampUtils

All Implemented Interfaces:

Closeable, AutoCloseable

public class SampUtils
extends Object
implements Closeable

Utilities for communicating with DS9. This code is ds9 specific, it is not easy to do the same thing perfectly generically, although support for other clients could presumably be added.

Author:

tonyj

Constructor Summary

Constructors

Constructor and Description
SampUtils(String name, boolean autoStartHub) Create an instance of SampUtils and attempt to connect to a SAMP hub.

Method Summary

Modifier and Type	Method and Description
void	close()
void	display(File file) Ask ds9 to display a fits file, assuming that the fits file is directly readable by ds9 and is mosaic iraf format .
List<Object>	ds9Get(String command, int timeout) Send a ds9.get command over SAMP.
void	ds9Set(String command, URI uri, int timeout) Send a ds9.set command over SAMP.
List<String>	getDS9Version() Get a list of versions of DS9 clients connected to hub.
static void	main(String[] args) Just for testing

Methods inherited from class java.lang.Object

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

Constructor Detail

SampUtils

public SampUtils(String name,
                 boolean autoStartHub)

Create an instance of SampUtils and attempt to connect to a SAMP hub.

Parameters:

name - The name of the subsystem (to be displayed in SAMP hub).

autoStartHub - If true attempt to start a hub if one is not already running.

Method Detail

display

public void display(File file)
             throws org.astrogrid.samp.client.SampException

Ask ds9 to display a fits file, assuming that the fits file is directly readable by ds9 and is mosaic iraf format . This code is ds9 specific, it is not easy to do the same thing perfectly generically.

Parameters:

file - The file to be displayed.

Throws:

org.astrogrid.samp.client.SampException - If an error occurs

getDS9Version

public List<String> getDS9Version()
                           throws org.astrogrid.samp.client.SampException

Get a list of versions of DS9 clients connected to hub.

Returns:

A List of the version numbers of DS9 clients connected to the hub, or an empty list if there are none.

Throws:

org.astrogrid.samp.client.SampException - If an errors occurs

ds9Set

public void ds9Set(String command,
                   URI uri,
                   int timeout)
            throws org.astrogrid.samp.client.SampException

Send a ds9.set command over SAMP. Currently this method just broadcasts the DS9 set command, and does not wait for a response, or check for errors (other than logging them).

Parameters:

command - The command to be sent to DS9.

uri - The optional URI to be sent, or null

timeout - The timeout (in milliseconds?)

Throws:

org.astrogrid.samp.client.SampException - If an error occurs sending the message (for example no hub running).

ds9Get

public List<Object> ds9Get(String command,
                           int timeout)
                    throws org.astrogrid.samp.client.SampException

Send a ds9.get command over SAMP. This command waits for responses and throws an exception if an error is received.

Parameters:

command - The command to send.

timeout - The timeout (in milliseconds?)

Returns:

The list of responses, one for each client that responds. This may be an empty list if no clients respond.

Throws:

org.astrogrid.samp.client.SampException - If an error occurs.

main

public static void main(String[] args)
                 throws org.astrogrid.samp.client.SampException

Just for testing

Parameters:

args -

Throws:

org.astrogrid.samp.client.SampException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException