org.lsst.ccs.drivers.demo

Class DemoDriver

java.lang.Object

org.lsst.ccs.drivers.demo.DemoDriver

public class DemoDriver
extends Object

General access routines for this device Driver methods are annotated for use by CCS command dictionary and shell system. Exceptions are passed through to next level where either subsystem or shell code handles them.

Author:

Your Name

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEVID0 The First of our devices

Constructor Summary

Constructors

Constructor and Description
DemoDriver() Constructor Generally not needed unless some initialization required at creation.

Method Summary

Modifier and Type	Method and Description
void	close() Close the device
int	getDevId() Gets the device ID
void	open(int did) Open the device
void	print(String userWord) Added by Farrukh Azfar - under close scrutiny from Massimiliano Turri Open the device
String	read(int count) Read the device
void	write(String input) Write to the device (would add address, etc.

Methods inherited from class java.lang.Object

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

Field Detail

DEVID0

public static final int DEVID0

The First of our devices

See Also:

Constant Field Values

Constructor Detail

DemoDriver

public DemoDriver()
           throws org.lsst.ccs.drivers.commons.DriverException

Constructor Generally not needed unless some initialization required at creation. See Ad7794Eval.java and TempControl24C.java for examples.

Throws:

org.lsst.ccs.drivers.commons.DriverException

Method Detail

getDevId

public int getDevId()

Gets the device ID

Returns:

The ID of the current open device, or -1 if no device open.

open

@Command(name="open",
         description="Open a device for use")
public void open(@Argument(name="devId",description="The device ID of the device to open")
                                                                                     int did)
                                                                              throws org.lsst.ccs.drivers.commons.DriverException

Open the device

Parameters:

did - The device identifier is index from our list of devs

Throws:

org.lsst.ccs.drivers.commons.DriverException

close

@Command(name="close",
         description="Close the device")
public void close()
                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Close the device

Parameters:

did - The device identifier is index from our list of devs

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

@Command(name="read",
         description="Read <count> bytes from device and print in hex format\n\tread <N> ")
public String read(@Argument(name="count",description="The number of bytes to read")
                                                                                                                                     int count)
                                                                                                                              throws Exception

Read the device

Parameters:

count - The number of bytes to read.

data - An array of sufficient size to contain the data.

Returns:

The number of bytes read

Throws:

org.lsst.ccs.drivers.commons.DriverException

Exception

write

@Command(name="write",
         description="write the input string to the device\n\twrite <input-string>")
public void write(@Argument(name="input-string",description="The input string")
                                                                                                                              String input)
                                                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Write to the device (would add address, etc. for real device)

Parameters:

count - The number of bytes to write.

buf - An array of bytes with the data to write

Throws:

org.lsst.ccs.drivers.commons.DriverException

print

@Command(name="print",
         description="print to screen at GUI or remote")
public void print(@Argument(name="printedWord",description="User input text string")
                                                                                                  String userWord)

Added by Farrukh Azfar - under close scrutiny from Massimiliano Turri Open the device

Parameters:

did - The device identifier is index from our list of devs