org.lsst.ccs.drivers.gpio

Class GPIODriver.GPIOChannel

java.lang.Object

org.lsst.ccs.drivers.gpio.GPIODriver.GPIOChannel

Enclosing class:

GPIODriver

public static final class GPIODriver.GPIOChannel
extends Object

A class representing a single GPIO Channel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GPIODriver.GPIOChannel.Direction Enumeration for specifying the direction of a channel

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the channel (to 0)
int	getChannel() Return the channel number for this channel.
GPIODriver.GPIOChannel.Direction	getDirection() Get the direction for this channel
void	lock() Locks this channel for exclusive access.
boolean	read() Read the current value of the channel
void	set() Set the channel (to 1)
void	setDirection(GPIODriver.GPIOChannel.Direction dir) Set the direction for this channel
String	toString()
void	unlock() Unlocks the specified channel.
void	write(boolean value) Write a new value to this channel

Methods inherited from class java.lang.Object

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

Method Detail

getDirection

public GPIODriver.GPIOChannel.Direction getDirection()
                                              throws org.lsst.ccs.drivers.commons.DriverException

Get the direction for this channel

Returns:

The direction

Throws:

org.lsst.ccs.drivers.commons.DriverException - If the direction cannot be determined

setDirection

public void setDirection(GPIODriver.GPIOChannel.Direction dir)
                  throws org.lsst.ccs.drivers.commons.DriverException

Set the direction for this channel

Parameters:

dir - The direction to be set.

Throws:

org.lsst.ccs.drivers.commons.DriverException - If the direction cannot be set.

set

public void set()
         throws org.lsst.ccs.drivers.commons.DriverException

Set the channel (to 1)

Throws:

org.lsst.ccs.drivers.commons.DriverException - If the channel cannot be set

clear

public void clear()
           throws org.lsst.ccs.drivers.commons.DriverException

Clear the channel (to 0)

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

public boolean read()
             throws org.lsst.ccs.drivers.commons.DriverException

Read the current value of the channel

Returns:

true if the channel is set (value == 1)

Throws:

org.lsst.ccs.drivers.commons.DriverException - If an error occurs

write

public void write(boolean value)
           throws org.lsst.ccs.drivers.commons.DriverException

Write a new value to this channel

Parameters:

value - The value to write

Throws:

org.lsst.ccs.drivers.commons.DriverException - If an error occurs

lock

public void lock()
          throws org.lsst.ccs.drivers.commons.DriverException

Locks this channel for exclusive access. This method works by taking an exclusive lock on the value file, which speeds up all subsequent read/write operations on the channel.

Throws:

org.lsst.ccs.drivers.commons.DriverException - If the lock cannot be obtained.

unlock

public void unlock()
            throws org.lsst.ccs.drivers.commons.DriverException

Unlocks the specified channel. If the channel is not locked the method does nothing.

Throws:

org.lsst.ccs.drivers.commons.DriverException - If the channel unlock fails

getChannel

public int getChannel()

Return the channel number for this channel.

Returns:

The channel number

toString

public String toString()

Overrides:

toString in class Object