com.phidgets.event
Class TagGainEvent

java.lang.Object
  com.phidgets.event.TagGainEvent

public class TagGainEvent

extends java.lang.Object

This class represents the data for a TagGainEvent.

Author:

Phidgets Inc.

Constructor Summary

TagGainEvent(Phidget source, java.lang.String value)
Class constructor.

TagGainEvent(Phidget source, java.lang.String value, int protocol)

Method Summary

int	getProtocol() Returns the protocol of the Tag that was lost.
Phidget	getSource() Returns the source Phidget of this event.
java.lang.String	getValue() Returns the gained tag.
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

TagGainEvent

public TagGainEvent(Phidget source,
                    java.lang.String 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

TagGainEvent

public TagGainEvent(Phidget source,
                    java.lang.String value,
                    int protocol)

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

getValue

public java.lang.String getValue()

Returns the gained tag.

Returns:

the gained tag

getProtocol

public int getProtocol()

Returns the protocol of the Tag that was lost.

Returns:

the lost tag protocol

toString

public java.lang.String toString()

Returns a string containing information about the event.

Returns:

an informative event string