com.phidgets.event
Class EncoderPositionChangeEvent

java.lang.Object
  com.phidgets.event.EncoderPositionChangeEvent

public class EncoderPositionChangeEvent

extends java.lang.Object

This class represents the data for a EncoderPositionChangeEvent.

Author:

Phidgets Inc.

Constructor Summary

EncoderPositionChangeEvent(Phidget source, int index, int time, int value)
Class constructor.

Method Summary

int	getIndex() Returns the index of the encoder.
Phidget	getSource() Returns the source Phidget of this event.
int	getTime() Returns the timestamp of this position change.
int	getValue() Returns the position change of the encoder.
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

EncoderPositionChangeEvent

public EncoderPositionChangeEvent(Phidget source,
                                  int index,
                                  int time,
                                  int 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 encoder.

Returns:

the index of the encoder

getValue

public int getValue()

Returns the position change of the encoder. This is the amount of change in the encoder's position since the last EncoderPositionChangeEvent(com.phidgets.Phidget, int, int, int).

Returns:

the change in position of the encoder

getTime

public int getTime()

Returns the timestamp of this position change. This is the time since the last EncoderPositionChangeEvent(com.phidgets.Phidget, int, int, int). This time is not represented in a real quantitly such as seconds, but can be used as a qualitative quantity.

Returns:

the timestamp of this change event

toString

public java.lang.String toString()

Returns a string containing information about the event.

Returns:

an informative event string