ValueChangedEvent (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- java.util.EventObject
- - com.ergotech.vib.valueobjects.ValueChangedEvent

All Implemented Interfaces:

java.io.Serializable
```
public class ValueChangedEvent
extends java.util.EventObject
```
This event will be used by a DataSource to tell a ValueChangedListener when its value has been updated. When the ValueChangedListener receives the event, it usually will ask for the boolean, int, float, string, or value object of the server. These methods will then ask the DataSource (or its source) what its current value is.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

ValueObjectInterface theValue
The value that is being passed by this event.

Fields
Modifier and Type	Field and Description
`ValueObjectInterface`	`theValue` The value that is being passed by this event.

Constructor Summary

Constructors
Constructor and Description
`ValueChangedEvent(DataSource source)` This is the default constructor.
`ValueChangedEvent(java.lang.Object source, ValueObjectInterface newValue)` This constructor takes an Object as the source (which should be a DataSource object in most cases) and a new value.
`ValueChangedEvent(java.lang.Object source, ValueObjectInterface newValue, ValueUpdateResponseListener valueUpdateResponseListener)` This constructor takes an Object as the source (which should be a DataSource object in most cases) and a new value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`getBinaryValue()` This will return the current value of the ValueObject as a byte array.
`boolean`	`getBoolValue()` This will return the current value as a boolean.
`byte`	`getByteValue()` This will return the current value as a byte.
`java.awt.Color`	`getColor()` This will return the current color for the data.
`java.util.Date`	`getDate()` This will return the date that the value was created.
`double`	`getDoubleValue()` This will return the current value as a double.
`float`	`getFloatValue()` This will return the current value as a float.
`int`	`getIntValue()` This will return the current value as a int.
`Connector`	`getLastConnector()`
`long`	`getLongValue()` This will return the current value as a long.
`double`	`getNumericValue()` This will return the current value as a double.
`java.lang.Object`	`getObjectValue()` This will return the current value.
`int`	`getQuality()` This will return the quality of the reading.
`short`	`getShortValue()` This will return the current value as a short.
`java.lang.String`	`getStringValue()` This will return the current value as a String.
`long`	`getTimeMillis()` This will return the number of milliseconds since Jan 1st 1970.
`char`	`getType()` This will return the type of data that the current value was last set by.
`ValueObjectInterface`	`getValueObject()` This will return the current value.
`ValueUpdateResponseListener`	`getValueUpdateResponseListener()` Returns the update response listener.
`void`	`setLastConnector(Connector lastConnector)`
`void`	`setValueUpdateResponseListener(ValueUpdateResponseListener valueUpdateResponseListener)` Sets the update response listener.
`java.lang.String`	`toString()` Returns a String representation of this ValueChangedEvent.

Methods inherited from class java.util.EventObject
getSource

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - theValue
```
public ValueObjectInterface theValue
```
    The value that is being passed by this event.
- Constructor Detail
  - ValueChangedEvent
```
public ValueChangedEvent(DataSource source)
```
    This is the default constructor. It takes only a DataSource object. The time stamp of this event is set to the current time (based on the computer's clock). The source is immediatly asked for its value object.
    
    Parameters:
    
    source - the data source that triggered the event
  - ValueChangedEvent
```
public ValueChangedEvent(java.lang.Object source,
                         ValueObjectInterface newValue)
```
    This constructor takes an Object as the source (which should be a DataSource object in most cases) and a new value. The time of this event is set to the current time (based on the computer's clock).
    
    Parameters:
    
    source - the source that triggered the event
    
    newValue - the new value
  - ValueChangedEvent
```
public ValueChangedEvent(java.lang.Object source,
                         ValueObjectInterface newValue,
                         ValueUpdateResponseListener valueUpdateResponseListener)
```
    This constructor takes an Object as the source (which should be a DataSource object in most cases) and a new value. The time of this event is set to the current time (based on the computer's clock).
    
    Parameters:
    
    source - the source that triggered the event
    
    newValue - the new value
    
    valueUpdateResponseListener - if non-null, this should be called after the value is updated.
- Method Detail
  - getBinaryValue
```
public byte[] getBinaryValue()
```
    This will return the current value of the ValueObject as a byte array.
    
    Returns:
    
    the value as a String
  - getBoolValue
```
public boolean getBoolValue()
```
    This will return the current value as a boolean.
    
    Returns:
    
    the current value (a boolean)
  - getByteValue
```
public byte getByteValue()
```
    This will return the current value as a byte.
    
    Returns:
    
    the current value (a byte)
  - getColor
```
public java.awt.Color getColor()
```
    This will return the current color for the data. WARNING: This can and will return null in many cases. Not all servers are required to send a color.
    
    Returns:
    
    a Color representing the current value level
    
    See Also:
    
    ValueObject.getColor()
  - getDate
```
public java.util.Date getDate()
```
    This will return the date that the value was created.
    
    Returns:
    
    the date the value was created
  - getDoubleValue
```
public double getDoubleValue()
```
    This will return the current value as a double.
    
    Returns:
    
    the current value (a double)
  - getFloatValue
```
public float getFloatValue()
```
    This will return the current value as a float.
    
    Returns:
    
    the current value (a float)
  - getIntValue
```
public int getIntValue()
```
    This will return the current value as a int.
    
    Returns:
    
    the current value (an integer)
  - getLastConnector
```
public Connector getLastConnector()
```
    Returns:
    
    Returns the lastConnector.
  - getLongValue
```
public long getLongValue()
```
    This will return the current value as a long.
    
    Returns:
    
    the current value (a long)
  - getNumericValue
```
public double getNumericValue()
                       throws java.lang.NumberFormatException
```
    This will return the current value as a double. This will throw a NumberFormatException is the current Value can not be converted (if it is a string for instance).
    
    Throws:
    
    java.lang.NumberFormatException
  - getObjectValue
```
public java.lang.Object getObjectValue()
```
    This will return the current value.
    
    Returns:
    
    the current value (as an Object)
  - getQuality
```
public int getQuality()
```
    This will return the quality of the reading.
    
    Returns:
    
    the data quality
    
    See Also:
    
    #setQuality
  - getShortValue
```
public short getShortValue()
```
    This will return the current value as a short.
    
    Returns:
    
    the current value (a short)
  - getStringValue
```
public java.lang.String getStringValue()
```
    This will return the current value as a String.
    
    Returns:
    
    the current value (a String)
  - getTimeMillis
```
public long getTimeMillis()
```
    This will return the number of milliseconds since Jan 1st 1970.
  - getType
```
public char getType()
```
    This will return the type of data that the current value was last set by.
    
    Returns:
    
    a char representing the data type
    
    See Also:
    
    ValueObject.getType()
  - getValueObject
```
public ValueObjectInterface getValueObject()
```
    This will return the current value.
    
    Returns:
    
    the current value (as a ValueObject)
  - getValueUpdateResponseListener
```
public ValueUpdateResponseListener getValueUpdateResponseListener()
```
    Returns the update response listener. The response listener should be called by the connector after the value is updated.
    
    Returns:
    
    the update response listener
  - setLastConnector
```
public void setLastConnector(Connector lastConnector)
```
    Parameters:
    
    lastConnector - The lastConnector to set.
  - setValueUpdateResponseListener
```
public void setValueUpdateResponseListener(ValueUpdateResponseListener valueUpdateResponseListener)
```
    Sets the update response listener. The response listener should be called by the connector after the value is updated.
    
    Parameters:
    
    valueUpdateResponseListener - the update response listener
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this ValueChangedEvent.
    
    Overrides:
    
    toString in class java.util.EventObject
    
    Returns:
    
    A a String representation of this ValueChangedEvent.

Class ValueChangedEvent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.EventObject

Methods inherited from class java.lang.Object

Field Detail

theValue

Constructor Detail

ValueChangedEvent

ValueChangedEvent

ValueChangedEvent

Method Detail

getBinaryValue

getBoolValue

getByteValue

getColor

getDate

getDoubleValue

getFloatValue

getIntValue

getLastConnector

getLongValue

getNumericValue

getObjectValue

getQuality

getShortValue

getStringValue

getTimeMillis

getType

getValueObject

getValueUpdateResponseListener

setLastConnector

setValueUpdateResponseListener

toString