aboutsummaryrefslogtreecommitdiffstats
path: root/Java/com/phidgets/event/TagGainEvent.java
diff options
context:
space:
mode:
Diffstat (limited to 'Java/com/phidgets/event/TagGainEvent.java')
-rw-r--r--Java/com/phidgets/event/TagGainEvent.java59
1 files changed, 59 insertions, 0 deletions
diff --git a/Java/com/phidgets/event/TagGainEvent.java b/Java/com/phidgets/event/TagGainEvent.java
new file mode 100644
index 0000000..6cb7a74
--- /dev/null
+++ b/Java/com/phidgets/event/TagGainEvent.java
@@ -0,0 +1,59 @@
+/*
+ * Copyright 2006 Phidgets Inc. All rights reserved.
+ */
+
+package com.phidgets.event;
+
+import com.phidgets.Phidget;
+
+/**
+ * This class represents the data for a TagGainEvent.
+ *
+ * @author Phidgets Inc.
+ */
+public class TagGainEvent
+{
+ Phidget source;
+ String value;
+
+ /**
+ * Class constructor. This is called internally by the phidget library when creating this event.
+ *
+ * @param source the Phidget object from which this event originated
+ */
+ public TagGainEvent(Phidget source, String value)
+ {
+ this.source = source;
+ this.value = value;
+ }
+
+ /**
+ * 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.
+ *
+ * @return the event caller
+ */
+ public Phidget getSource() {
+ return source;
+ }
+
+ /**
+ * Returns the gained tag. The tag is a 10 digit hex number represented as a string.
+ *
+ * @return the gained tag
+ */
+ public String getValue() {
+ return value;
+ }
+
+ /**
+ * Returns a string containing information about the event.
+ *
+ * @return an informative event string
+ */
+ public String toString() {
+ return source.toString() + " Tag Gained: "
+ + value;
+ }
+}