com.phidgets.event
Class CurrentUpdateEvent

java.lang.Object
  com.phidgets.event.CurrentUpdateEvent

public class CurrentUpdateEvent

extends java.lang.Object

This class represents the data for a CurrentUpdateEvent.

Author:

Phidgets Inc.

Constructor Summary

CurrentUpdateEvent(Phidget source, int index, double value)
Class constructor.

Method Summary

int	getIndex() Returns the index of the motor.
Phidget	getSource() Returns the source Phidget of this event.
double	getValue() Returns the current of the motor.
java.lang.String	toString() Returns a string containing information about the event.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CurrentUpdateEvent

public CurrentUpdateEvent(Phidget source,
                          int index,
                          double value)

Class constructor. This is called internally by the Phidget library when creating this event.

Parameters:

source - the Phidget object from which this event originated

Method Detail

getSource

public Phidget getSource()

Returns the source Phidget of this event. This is a reference to the Phidget object from which this event was called. This object can be cast into a specific type of Phidget object to call specific device calls on it.

Returns:

the event caller

getIndex

public int getIndex()

Returns the index of the motor.

Returns:

the index of the motor

getValue

public double getValue()

Returns the current of the motor. This is a representation of the amount of current being used by the motor.

Returns:

the motor's current draw

toString

public java.lang.String toString()

Returns a string containing information about the event.

Returns:

an informative event string