JVariant (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.vib.servers.opc.opcwrapper.dcomwrapper.JVariant

public class JVariant
extends java.lang.Object

A Java representation of a Windows VARIANT

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`cvsRev`
`static int`	`OPC_QUALITY_BAD`
`static int`	`OPC_QUALITY_COMM_FAILURE`
`static int`	`OPC_QUALITY_CONFIG_ERROR`
`static int`	`OPC_QUALITY_DEVICE_FAILURE`
`static int`	`OPC_QUALITY_EGU_EXCEEDED`
`static int`	`OPC_QUALITY_GOOD`
`static int`	`OPC_QUALITY_LAST_KNOWN`
`static int`	`OPC_QUALITY_LAST_USABLE`
`static int`	`OPC_QUALITY_LOCAL_OVERRIDE`
`static int`	`OPC_QUALITY_NOT_CONNECTED`
`static int`	`OPC_QUALITY_OUT_OF_SERVICE`
`static int`	`OPC_QUALITY_SENSOR_CAL`
`static int`	`OPC_QUALITY_SENSOR_FAILURE`
`static int`	`OPC_QUALITY_SIMULATED`
`static int`	`OPC_QUALITY_SUB_NORMAL`
`static int`	`OPC_QUALITY_UNCERTAIN`
`int`	`quality` The quality.
`java.util.Date`	`timestamp` The timestamp.
`java.lang.Object`	`value` The current value.
`int`	`variantType` The variant type.
`static int`	`VT_ARRAY`
`static int`	`VT_BOOL`
`static int`	`VT_BSTR`
`static int`	`VT_CY`
`static int`	`VT_DATE`
`static int`	`VT_EMPTY`
`static int`	`VT_I2`
`static int`	`VT_I4`
`static int`	`VT_R4`
`static int`	`VT_R8`
`static int`	`VT_UI1`
`static int`	`VT_VARIANT`

Constructor Summary

Constructors
Constructor and Description

JVariant()
Create a new object with no value.

JVariant(java.lang.Object initialValue)
Create an object with the initial value.

Constructors
Constructor and Description
`JVariant()` Create a new object with no value.
`JVariant(java.lang.Object initialValue)` Create an object with the initial value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object theObject)` Make sure that two defs with the same value are the same.
`java.lang.Object`	`getArrayElementAt(int index)` Returns the element at the index in the array.
`int`	`getArraySize()` Returns the size of the value if it is an array, otherwise zero.
`java.lang.Object`	`getArrayValue()` Returns a string representation of the current value.
`int`	`getBoolValue()` Returns the current value as a boolean.
`double`	`getDoubleValue()` Returns the double representation of the current value.
`int`	`getIntValue()` Returns the integer representation of the current value.
`int`	`getJavaType()` Returns the type of the current value.
`int`	`getQuality()`
`java.lang.String`	`getStringValue()` Returns a string representation of the current value.
`java.util.Date`	`getTimestamp()`
`java.lang.Object`	`getValue()` Returns the current value.
`int`	`getVariantType()` Returns the type of the JVariant in the Windows VT_XXX format.
`static java.util.Vector`	`getVariantTypeNames()` Returns a hash table of the names of all types.
`static java.util.Hashtable`	`getVariantTypes()` Returns a hash table of all types.
`void`	`setArrayElementAt(java.lang.Object element, int index)` Sets the element at the given index in the value array.
`void`	`setArraySize(int size)` Sets the size of the value array and creates the array.
`void`	`setArrayValue(java.lang.Object array)` Set the current value as an array.
`void`	`setBoolValue(int boolVal)` Sets the current value as a boolean.
`void`	`setDoubleValue(double doubleValue)` Set the current value as an int.
`void`	`setIntValue(int intValue)` Set the current value as an int.
`void`	`setQuality(int quality)`
`void`	`setStringValue(java.lang.String strValue)` Set the current value as an string.
`void`	`setTimestamp(java.util.Date timestamp)`
`void`	`setValue(java.lang.Object newValue)` Sets the current value.
`void`	`setVariantType(int type)` Set the type in Windows VT_XXX format.
`java.lang.String`	`toString()` Returns a string representation of this object.

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

- Field Detail
  - cvsRev
```
public static final java.lang.String cvsRev
```
    See Also:
    
    Constant Field Values
  - OPC_QUALITY_BAD
```
public static final int OPC_QUALITY_BAD
```
    See Also:
    
    Constant Field Values
  - OPC_QUALITY_COMM_FAILURE
```
public static final int OPC_QUALITY_COMM_FAILURE
```
    See Also:
    
    Constant Field Values
  - OPC_QUALITY_CONFIG_ERROR
```
public static final int OPC_QUALITY_CONFIG_ERROR
```
    See Also:
    
    Constant Field Values
  - OPC_QUALITY_DEVICE_FAILURE
```
public static final int OPC_QUALITY_DEVICE_FAILURE
```
    See Also:
    
    Constant Field Values
  - OPC_QUALITY_EGU_EXCEEDED
```
public static final int OPC_QUALITY_EGU_EXCEEDED
```
    See Also:
    
    Constant Field Values
  - OPC_QUALITY_GOOD
```
public static final int OPC_QUALITY_GOOD
```
    See Also:
    
    Constant Field Values
  - OPC_QUALITY_LAST_KNOWN
```
public static final int OPC_QUALITY_LAST_KNOWN
```
    See Also:
    
    Constant Field Values
  - OPC_QUALITY_LAST_USABLE
```
public static final int OPC_QUALITY_LAST_USABLE
```
    See Also:
    
    Constant Field Values
  - OPC_QUALITY_LOCAL_OVERRIDE
```
public static final int OPC_QUALITY_LOCAL_OVERRIDE
```
    See Also:
    
    Constant Field Values
  - OPC_QUALITY_NOT_CONNECTED
```
public static final int OPC_QUALITY_NOT_CONNECTED
```
    See Also:
    
    Constant Field Values
  - OPC_QUALITY_OUT_OF_SERVICE
```
public static final int OPC_QUALITY_OUT_OF_SERVICE
```
    See Also:
    
    Constant Field Values
  - OPC_QUALITY_SENSOR_CAL
```
public static final int OPC_QUALITY_SENSOR_CAL
```
    See Also:
    
    Constant Field Values
  - OPC_QUALITY_SENSOR_FAILURE
```
public static final int OPC_QUALITY_SENSOR_FAILURE
```
    See Also:
    
    Constant Field Values
  - OPC_QUALITY_SIMULATED
```
public static final int OPC_QUALITY_SIMULATED
```
    See Also:
    
    Constant Field Values
  - OPC_QUALITY_SUB_NORMAL
```
public static final int OPC_QUALITY_SUB_NORMAL
```
    See Also:
    
    Constant Field Values
  - OPC_QUALITY_UNCERTAIN
```
public static final int OPC_QUALITY_UNCERTAIN
```
    See Also:
    
    Constant Field Values
  - quality
```
public int quality
```
    The quality. A convenience since we are almost always interested in the quality when we create a JVariant.
  - timestamp
```
public java.util.Date timestamp
```
    The timestamp. A convenience since we are almost always interested in the timestamp when we create a JVariant.
  - value
```
public java.lang.Object value
```
    The current value.
  - variantType
```
public int variantType
```
    The variant type.
  - VT_ARRAY
```
public static final int VT_ARRAY
```
    See Also:
    
    Constant Field Values
  - VT_BOOL
```
public static final int VT_BOOL
```
    See Also:
    
    Constant Field Values
  - VT_BSTR
```
public static final int VT_BSTR
```
    See Also:
    
    Constant Field Values
  - VT_CY
```
public static final int VT_CY
```
    See Also:
    
    Constant Field Values
  - VT_DATE
```
public static final int VT_DATE
```
    See Also:
    
    Constant Field Values
  - VT_EMPTY
```
public static final int VT_EMPTY
```
    See Also:
    
    Constant Field Values
  - VT_I2
```
public static final int VT_I2
```
    See Also:
    
    Constant Field Values
  - VT_I4
```
public static final int VT_I4
```
    See Also:
    
    Constant Field Values
  - VT_R4
```
public static final int VT_R4
```
    See Also:
    
    Constant Field Values
  - VT_R8
```
public static final int VT_R8
```
    See Also:
    
    Constant Field Values
  - VT_UI1
```
public static final int VT_UI1
```
    See Also:
    
    Constant Field Values
  - VT_VARIANT
```
public static final int VT_VARIANT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JVariant
```
public JVariant()
```
    Create a new object with no value.
  - JVariant
```
public JVariant(java.lang.Object initialValue)
```
    Create an object with the initial value.
    
    Parameters:
    
    initialValue - the initial value
- Method Detail
  - equals
```
public boolean equals(java.lang.Object theObject)
```
    Make sure that two defs with the same value are the same.
    
    Overrides:
    
    equals in class java.lang.Object
  - getArrayElementAt
```
public java.lang.Object getArrayElementAt(int index)
```
    Returns the element at the index in the array. This method will return null if the index is too large or the value is not an array
    
    Parameters:
    
    index - the index into the array
    
    Returns:
    
    the JVariant at the given index
  - getArraySize
```
public int getArraySize()
```
    Returns the size of the value if it is an array, otherwise zero.
    
    Returns:
    
    the size of the value array
  - getArrayValue
```
public java.lang.Object getArrayValue()
```
    Returns a string representation of the current value.
    
    Returns:
    
    value.toString();
  - getBoolValue
```
public int getBoolValue()
```
    Returns the current value as a boolean. If the current value is not a Number then the return will be -1 if the toString() of the object represents the string "true" otherwise it will 0.
    
    Returns:
    
    0 if the current value is false otherwise -1
  - getDoubleValue
```
public double getDoubleValue()
```
    Returns the double representation of the current value.
    
    Returns:
    
    the value as an double
  - getIntValue
```
public int getIntValue()
```
    Returns the integer representation of the current value.
    
    Returns:
    
    the value as an int
  - getJavaType
```
public int getJavaType()
```
    Returns the type of the current value. The return uses the Java type returns rather than the Window VT_XXX types.
  - getQuality
```
public int getQuality()
```
    Returns:
    
    Returns the quality.
  - getStringValue
```
public java.lang.String getStringValue()
```
    Returns a string representation of the current value.
    
    Returns:
    
    value.toString();
  - getTimestamp
```
public java.util.Date getTimestamp()
```
    Returns:
    
    Returns the timestamp.
  - getValue
```
public java.lang.Object getValue()
```
    Returns the current value.
    
    Returns:
    
    value
  - getVariantType
```
public int getVariantType()
```
    Returns the type of the JVariant in the Windows VT_XXX format.
    
    Returns:
    
    the variant type
  - getVariantTypeNames
```
public static java.util.Vector getVariantTypeNames()
```
    Returns a hash table of the names of all types. This vector is sorted in a logical order.
  - getVariantTypes
```
public static java.util.Hashtable getVariantTypes()
```
    Returns a hash table of all types.
  - setArrayElementAt
```
public void setArrayElementAt(java.lang.Object element,
                              int index)
```
    Sets the element at the given index in the value array. If the value is not an array then this method does nothing.
    
    Parameters:
    
    index - the index into the array
    
    element - JVariant to store at the given index
  - setArraySize
```
public void setArraySize(int size)
```
    Sets the size of the value array and creates the array. This must be called before "setArrayElementAt". The array cannot be resize. If this method is called a second time all data previously set to the value array will be lost.
    
    Parameters:
    
    the - size of the array
  - setArrayValue
```
public void setArrayValue(java.lang.Object array)
                   throws java.lang.IllegalArgumentException
```
    Set the current value as an array. The value will be stored as an array. The value will be checked to ensure that it is an array. If the object passed is not an array, then an IllegalArgumentException is thrown and no changes are made to the object.
    
    Parameters:
    
    strValue - the value to store
    
    Throws:
    
    java.lang.IllegalArgumentException - if the value passed in is not an array
  - setBoolValue
```
public void setBoolValue(int boolVal)
```
    Sets the current value as a boolean.
    
    Parameters:
    
    boolVal - the value to set
  - setDoubleValue
```
public void setDoubleValue(double doubleValue)
```
    Set the current value as an int. The value will be stored as an Double.
    
    Parameters:
    
    doubleValue - the value to store
  - setIntValue
```
public void setIntValue(int intValue)
```
    Set the current value as an int. The value will be stored as an Integer.
    
    Parameters:
    
    intValue - the value to store
  - setQuality
```
public void setQuality(int quality)
```
    Parameters:
    
    quality - The quality to set.
  - setStringValue
```
public void setStringValue(java.lang.String strValue)
```
    Set the current value as an string. The value will be stored as an String.
    
    Parameters:
    
    strValue - the value to store
  - setTimestamp
```
public void setTimestamp(java.util.Date timestamp)
```
    Parameters:
    
    timestamp - The timestamp to set.
  - setValue
```
public void setValue(java.lang.Object newValue)
```
    Sets the current value.
    
    Parameters:
    
    newValue - the new value
  - setVariantType
```
public void setVariantType(int type)
```
    Set the type in Windows VT_XXX format.
    
    Parameters:
    
    type - the windows type.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    value.toString()

Class JVariant

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cvsRev

OPC_QUALITY_BAD

OPC_QUALITY_COMM_FAILURE

OPC_QUALITY_CONFIG_ERROR

OPC_QUALITY_DEVICE_FAILURE

OPC_QUALITY_EGU_EXCEEDED

OPC_QUALITY_GOOD

OPC_QUALITY_LAST_KNOWN

OPC_QUALITY_LAST_USABLE

OPC_QUALITY_LOCAL_OVERRIDE

OPC_QUALITY_NOT_CONNECTED

OPC_QUALITY_OUT_OF_SERVICE

OPC_QUALITY_SENSOR_CAL

OPC_QUALITY_SENSOR_FAILURE

OPC_QUALITY_SIMULATED

OPC_QUALITY_SUB_NORMAL

OPC_QUALITY_UNCERTAIN

quality

timestamp

value

variantType

VT_ARRAY

VT_BOOL

VT_BSTR

VT_CY

VT_DATE

VT_EMPTY

VT_I2

VT_I4

VT_R4

VT_R8

VT_UI1

VT_VARIANT

Constructor Detail

JVariant

JVariant

Method Detail

equals

getArrayElementAt

getArraySize

getArrayValue

getBoolValue

getDoubleValue

getIntValue

getJavaType

getQuality

getStringValue

getTimestamp

getValue

getVariantType

getVariantTypeNames

getVariantTypes

setArrayElementAt

setArraySize

setArrayValue

setBoolValue

setDoubleValue

setIntValue

setQuality

setStringValue

setTimestamp

setValue

setVariantType

toString