edu.berkeley.guir.ptk.output
Class PhidgetLEDOutput

java.lang.Object
  edu.berkeley.guir.ptk.PTK
      edu.berkeley.guir.ptk.output.Output
          edu.berkeley.guir.ptk.output.PhidgetLEDOutput

All Implemented Interfaces:

Phidgets._IPhidgetManagerEvents, java.util.EventListener, java.lang.Runnable

public abstract class PhidgetLEDOutput

extends Output

implements Phidgets._IPhidgetManagerEvents

Provides functionality for using a PhidgetLED as a PTK Output. Implements _IPhidgetManagerEvents and provides default functionality for the functions this Interface defines. A single PhidgetLEDOutput object corresponds to a single physical Phidget LED - the object is assigned the serial number of the physical hardware upon instantiation.

The serial number is assigned on the microprocessor of the connector circuit board (i.e., the LED itself does not have a serial number - the USB port to USB hub / device board has a serial number.

Author:

tmatthew

Field Summary

protected Phidgets.PhidgetLED	led
static java.lang.String	LED
protected Phidgets.PhidgetManager	manager
int	my_serial_num The serial number is assigned on the microprocessor of the connector circuit board (i.e., the LED itself does not have a serial number - the USB port to USB hub / device board has a serial number.

Fields inherited from class edu.berkeley.guir.ptk.output.Output

animatable, d_queue, data_ids_I_want, history, ITEMS_LENGTH, metadata_I_want, num_ids, num_metadata, output_cycle_time, transition

Fields inherited from class edu.berkeley.guir.ptk.PTK

debug, MAX_DEBUG, MED_DEBUG, MIN_DEBUG, NO_DEBUG

Fields inherited from interface Phidgets._IPhidgetManagerEvents

event_package, id_1, id_2, id_3

Constructor Summary

PhidgetLEDOutput(int serial)
Initializes the PhidgetManager, which listens for new Phidgets to be "attached."

PhidgetLEDOutput(int serial, boolean animatable)
Initializes the PhidgetManager and indicates that this Output will be animatable.

PhidgetLEDOutput(int serial, java.lang.String data_id)

PhidgetLEDOutput(int serial, java.lang.String[] data_ids_I_want)
Initializes the PhidgetManager and set the data IDs of data this Output can display.

PhidgetLEDOutput(int serial, java.lang.String[] data_ids_I_want, boolean animatable)

PhidgetLEDOutput(int serial, java.lang.String[] data_ids_I_want, Transition t)

PhidgetLEDOutput(int serial, java.lang.String data_id, boolean animatable)

PhidgetLEDOutput(int serial, java.lang.String data_id, Transition t)

PhidgetLEDOutput(int serial, Transition t)
Initializes the PhidgetManager and provides a custom Transition object.

Method Summary

abstract void	initialize() This method is called after the Phidget with the correct serial number is attached; put initialization code for the Phidget here.
protected void	initManager()
void	OnAttach(Phidgets._IPhidgetManagerEvents_OnAttachEvent e) Called when a Phidget is attached (i.e., plugged in) and detected by the program.
void	OnDetach(Phidgets._IPhidgetManagerEvents_OnDetachEvent e) Called when a Phidget is detatched (i.e., unplugged).
void	OnError(Phidgets._IPhidgetManagerEvents_OnErrorEvent e) Called when a Phidget has an error.

Methods inherited from class edu.berkeley.guir.ptk.output.Output

addDataID, addMetadataIWant, checkAction, displayEvent, doIWant, getAllMetadata, getDataIDs, getFirstMetadata, getHistory, handleEvent, interDisplayEvent, isAnimatable, printMetadataIWant, run, setChangeblindTransitionSteps, setDataIDsIWant, setInterruptTransitionSteps, setMakeawareTransitionSteps, setTimeBetweenDisplayEvents, setTransition, setUnsetNotification

Methods inherited from class edu.berkeley.guir.ptk.PTK

getMAX, getMED, getMIN, getNO, printDebug, printDebug, printError

Methods inherited from class java.lang.Object

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

Field Detail

LED

public static final java.lang.String LED

See Also:

Constant Field Values

my_serial_num

public int my_serial_num

The serial number is assigned on the microprocessor of the connector circuit board (i.e., the LED itself does not have a serial number - the USB port to USB hub / device board has a serial number.

led

protected Phidgets.PhidgetLED led

manager

protected Phidgets.PhidgetManager manager

Constructor Detail

PhidgetLEDOutput

public PhidgetLEDOutput(int serial)

Initializes the PhidgetManager, which listens for new Phidgets to be "attached."

Parameters:

serial - the serial number of the Phidget.

PhidgetLEDOutput

public PhidgetLEDOutput(int serial,
                        boolean animatable)

Initializes the PhidgetManager and indicates that this Output will be animatable.

Parameters:

serial - the serial number of the Phidget.

animatable - boolean = true, indicating that the Output is animatable (you do not need to pass in this boolean if the Output is not animatable, since the default is false).

PhidgetLEDOutput

public PhidgetLEDOutput(int serial,
                        Transition t)

Initializes the PhidgetManager and provides a custom Transition object.

Parameters:

serial - the serial number of the Phidget.

t - custom Transition object.

PhidgetLEDOutput

public PhidgetLEDOutput(int serial,
                        java.lang.String[] data_ids_I_want)

Initializes the PhidgetManager and set the data IDs of data this Output can display.

Parameters:

serial -

data_ids_I_want -

PhidgetLEDOutput

public PhidgetLEDOutput(int serial,
                        java.lang.String[] data_ids_I_want,
                        boolean animatable)

PhidgetLEDOutput

public PhidgetLEDOutput(int serial,
                        java.lang.String[] data_ids_I_want,
                        Transition t)

PhidgetLEDOutput

public PhidgetLEDOutput(int serial,
                        java.lang.String data_id)

PhidgetLEDOutput

public PhidgetLEDOutput(int serial,
                        java.lang.String data_id,
                        boolean animatable)

PhidgetLEDOutput

public PhidgetLEDOutput(int serial,
                        java.lang.String data_id,
                        Transition t)

Method Detail

initManager

protected void initManager()

initialize

public abstract void initialize()

This method is called after the Phidget with the correct serial number is attached; put initialization code for the Phidget here.

OnAttach

public void OnAttach(Phidgets._IPhidgetManagerEvents_OnAttachEvent e)

Called when a Phidget is attached (i.e., plugged in) and detected by the program. Checks to be sure the Phidget is an LED with the correct serial number, instantiates a PhidgetLED, and calls initialize().

Specified by:

OnAttach in interface Phidgets._IPhidgetManagerEvents

OnDetach

public void OnDetach(Phidgets._IPhidgetManagerEvents_OnDetachEvent e)

Called when a Phidget is detatched (i.e., unplugged). Checks to be sure the Phidget is an LED with the correct serial number and then sets the PhidgetLED object to null.

Specified by:

OnDetach in interface Phidgets._IPhidgetManagerEvents

OnError

public void OnError(Phidgets._IPhidgetManagerEvents_OnErrorEvent e)

Called when a Phidget has an error.

Specified by:

OnError in interface Phidgets._IPhidgetManagerEvents