BinaryValueObject (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.vib.valueobjects.ValueObject
- - com.ergotech.vib.valueobjects.BinaryValueObject

All Implemented Interfaces:

ValueObjectInterface, java.lang.Cloneable
```
public class BinaryValueObject
extends ValueObject
```
This is the instance of ValueObject that is created when you use the setBoolValue(), setIntValue(), setFloatValue() and setStringValue(). Notice that this method does not store Objects. This is because we can not copy an Object and all ValueObjects must be able to copy themselves.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String cvsRev
- Fields inherited from class com.ergotech.vib.valueobjects.ValueObject
  defaultTTL, locale, traceDefault, valueForTrue
- Fields inherited from interface com.ergotech.vib.valueobjects.ValueObjectInterface
  ANYTYPE, ARRAYTYPE, BINARYTYPE, BOOLEANTYPE, BYTETYPE, CHARTYPE, DISPLAYVALUE, DOUBLETYPE, FLOATTYPE, GROUP_NAME, INITIALVALUE, INTTYPE, LOG_MESSAGE, LONGTYPE, NAME, OBJECTTYPE, ORDER, PASSWORD_DIGEST, PROPERTYTYPE, QUALITY_BAD, QUALITY_COMM_FAILURE, QUALITY_DEVICE_FAILURE, QUALITY_EGU_EXCEEDED, QUALITY_EVALUATION_EXPIRED, QUALITY_GOOD, QUALITY_IMPOSSIBLE, QUALITY_INITIAL, QUALITY_LAST_USABLE, QUALITY_OUT_OF_SERVICE, QUALITY_PROPERTYONLY, QUALITY_REMOTE_PROXY_INIT, QUALITY_SIMULATED, QUALITY_SOURCE_REMOVED, QUALITY_TRANSITIONAL, QUALITY_UNKNOWN, QUALITY_WARNING, QUALITY_WORST, QUALITY_WRITE_IN_PROGRESS, REQUESTCURRENTVALUE, REQUESTHISTORICAL, SHORTTYPE, STRINGTYPE, TRACE, TWODTYPE, UNSIGNEDBYTETYPE, UNSIGNEDINTTYPE, UNSIGNEDLONGTYPE, UNSIGNEDSHORTTYPE, USER_NAME

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`cvsRev`

Constructor Summary

Constructors
Constructor and Description
`BinaryValueObject()` The default constructor.
`BinaryValueObject(byte[] newValue)` Creates a value object with the current integer value.
`BinaryValueObject(byte[] newValue, java.awt.Color newColor)` Creates a value object with the current integer value.
`BinaryValueObject(int newValue)` Creates a value object with a specific size.
`BinaryValueObject(int newValue, java.awt.Color newColor)` Creates a value object with the current size.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ValueObjectInterface`	`copy()` Returns a shallow copy of the value object.
`boolean`	`equals(java.lang.Object theObject)` This will return true if theObject is an instance of ValueObject and its double value is the same as ours.
`byte`	`getBinaryAt(int location)` This will set a specific element in the array.
`byte[]`	`getBinaryValue()` This will return the binary array.
`boolean`	`getBoolValue()` Returns the current value represented as a boolean.
`byte`	`getByteValue()` Returns the current value represented as an byte.
`char`	`getCharValue()` Returns the current value represented as a char.
`double`	`getDoubleValue()` Returns the current value represented as a float.
`float`	`getFloatValue()` Returns the current value represented as an float.
`java.lang.String`	`getHexString(byte value)` Convert the binary value to a hex string.
`int`	`getIntValue()` Returns the current value represented as an integer.
`long`	`getLongValue()` Returns the current value represented as a long.
`double`	`getNumericValue()` Returns the double value, but will throw an exception if the object isn't convertable.
`java.lang.Object`	`getObjectValue()` Returns the current value represented as an Object.
`short`	`getShortValue()` Returns the current value represented as a short.
`java.lang.String`	`getStringValue()` Returns the current value represented as an String.
`int`	`hashCode()`
`void`	`setBinaryAt(byte newValue, int location)` This will set a specific element in the array.
`void`	`setBinaryValue(byte[] newValue)` This will set the current value as an array.
`java.lang.String`	`toString()` Convert the binary value to a hex string.

Methods inherited from class com.ergotech.vib.valueobjects.ValueObject
acquireLatestPropertiesFrom, acquirePropertiesFrom, attributeNames, compareTo, convertToLowestPrecisionNumber, decrementTTL, escapeJSON, getAlwaysSend, getColor, getDate, getLocale, getLowestPrecisionValueObject, getProperties, getProperty, getQuality, getQualityString, getTime, getTimeMillis, getTTL, getType, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, replaces, setAlwaysSend, setColor, setDate, setLocale, setProperty, setQuality, setTimeMillis, setTTL, setType, setValueForTrue, shouldTrace, toJSON, toJSON, toJSON

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

- Field Detail
  - cvsRev
```
public static final java.lang.String cvsRev
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BinaryValueObject
```
public BinaryValueObject()
```
    The default constructor. It sets the current value to an integer value of 0.
  - BinaryValueObject
```
public BinaryValueObject(byte[] newValue)
```
    Creates a value object with the current integer value.
    
    Parameters:
    
    newValue - The value stored
  - BinaryValueObject
```
public BinaryValueObject(byte[] newValue,
                         java.awt.Color newColor)
```
    Creates a value object with the current integer value. and the color associated with that value (newColor).
    
    Parameters:
    
    newValue - the value stored
    
    newColor - the color assocaiated with the newValue.
  - BinaryValueObject
```
public BinaryValueObject(int newValue)
```
    Creates a value object with a specific size.
    
    Parameters:
    
    newValue - The value stored
  - BinaryValueObject
```
public BinaryValueObject(int newValue,
                         java.awt.Color newColor)
```
    Creates a value object with the current size. and the color associated with that value (newColor).
    
    Parameters:
    
    newValue - the value stored
    
    newColor - the color assocaiated with the newValue.
- Method Detail
  - copy
```
public ValueObjectInterface copy()
```
    Returns a shallow copy of the value object.
    
    Returns:
    
    a shallow copy of the value object
  - equals
```
public boolean equals(java.lang.Object theObject)
```
    This will return true if theObject is an instance of ValueObject and its double value is the same as ours.
    
    Specified by:
    
    equals in interface ValueObjectInterface
    
    Overrides:
    
    equals in class ValueObject
    
    Returns:
    
    a boolean result of the equals operation
  - getBinaryAt
```
public byte getBinaryAt(int location)
```
    This will set a specific element in the array.
  - getBinaryValue
```
public byte[] getBinaryValue()
```
    This will return the binary array.
    
    Specified by:
    
    getBinaryValue in interface ValueObjectInterface
    
    Overrides:
    
    getBinaryValue in class ValueObject
    
    Returns:
    
    the current binary array.
  - getBoolValue
```
public boolean getBoolValue()
```
    Returns the current value represented as a boolean. This is defined as true if the currentValue is not equal to 0, and false if it is.
    
    Returns:
    
    the current value as a boolean
  - getByteValue
```
public byte getByteValue()
```
    Returns the current value represented as an byte.
    
    Returns:
    
    the current value as a byte
  - getCharValue
```
public char getCharValue()
```
    Returns the current value represented as a char.
    
    Returns:
    
    the current value as a char
  - getDoubleValue
```
public double getDoubleValue()
```
    Returns the current value represented as a float.
    
    Returns:
    
    the current value as a double
    
    See Also:
    
    ValueObjectInterface.getNumericValue()
  - getFloatValue
```
public float getFloatValue()
```
    Returns the current value represented as an float.
    
    Returns:
    
    the current value as an float
  - getHexString
```
public java.lang.String getHexString(byte value)
```
    Convert the binary value to a hex string.
  - getIntValue
```
public int getIntValue()
```
    Returns the current value represented as an integer.
    
    Returns:
    
    the current value as an integer
  - getLongValue
```
public long getLongValue()
```
    Returns the current value represented as a long.
    
    Returns:
    
    the current value as a long
  - getNumericValue
```
public double getNumericValue()
                       throws java.lang.NumberFormatException
```
    Returns the double value, but will throw an exception if the object isn't convertable.
    
    Returns:
    
    the current value as a double
    
    Throws:
    
    java.lang.NumberFormatException
    
    See Also:
    
    ValueObjectInterface.getDoubleValue()
  - getObjectValue
```
public java.lang.Object getObjectValue()
```
    Returns the current value represented as an Object.
    
    Returns:
    
    the current value as an Object
  - getShortValue
```
public short getShortValue()
```
    Returns the current value represented as a short.
    
    Returns:
    
    the current value as a short
  - getStringValue
```
public java.lang.String getStringValue()
```
    Returns the current value represented as an String.
    
    Returns:
    
    the current value as a String
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class ValueObject
  - setBinaryAt
```
public void setBinaryAt(byte newValue,
                        int location)
```
    This will set a specific element in the array.
  - setBinaryValue
```
public void setBinaryValue(byte[] newValue)
```
    This will set the current value as an array.
  - toString
```
public java.lang.String toString()
```
    Convert the binary value to a hex string.
    
    Overrides:
    
    toString in class ValueObject

Class BinaryValueObject

Field Summary

Fields inherited from class com.ergotech.vib.valueobjects.ValueObject

Fields inherited from interface com.ergotech.vib.valueobjects.ValueObjectInterface

Constructor Summary

Method Summary

Methods inherited from class com.ergotech.vib.valueobjects.ValueObject

Methods inherited from class java.lang.Object

Field Detail

cvsRev

Constructor Detail

BinaryValueObject

BinaryValueObject

BinaryValueObject

BinaryValueObject

BinaryValueObject

Method Detail

copy

equals

getBinaryAt

getBinaryValue

getBoolValue

getByteValue

getCharValue

getDoubleValue

getFloatValue

getHexString

getIntValue

getLongValue

getNumericValue

getObjectValue

getShortValue

getStringValue

hashCode

setBinaryAt

setBinaryValue

toString