DataValue (prosys-opc-ua-sdk-client-server-pubsub 5.6.2-227 API)

java.lang.Object
- com.prosysopc.ua.stack.builtintypes.DataValue

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

StructureDataValue
```
public class DataValue
extends Object
implements Cloneable
```
DataValue class.

Field Summary

Fields
Modifier and Type Field and Description

static DataValue[] EMPTY_ARRAY

static NodeId ID
Deprecated.
use Identifiers.DataValue instead.

Fields
Modifier and Type	Field and Description
`static DataValue[]`	`EMPTY_ARRAY`
`static NodeId`	`ID` Deprecated. use `Identifiers.DataValue` instead.

Constructor Summary

Constructors
Constructor and Description
`DataValue()` Constructor for DataValue.
`DataValue(StatusCode statusCode)` Constructor for DataValue.
`DataValue(Variant variant)` Constructor for DataValue.
`DataValue(Variant value, StatusCode statusCode)` Constructor for DataValue.
`DataValue(Variant value, StatusCode statusCode, DateTime sourceTimestamp, DateTime serverTimestamp)` Constructor for DataValue.
`DataValue(Variant value, StatusCode statusCode, DateTime sourceTimestamp, UnsignedShort sourcePicoseconds, DateTime serverTimestamp, UnsignedShort serverPicoseconds)` Constructor for DataValue.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataValue`	`clone()`
`static DataValue`	`defaultValue(Class<?> compositeClass)` Get a new DataValue instance initialized to a default value of javaClass.
`static DataValue`	`defaultValue(Class<?> compositeClass, int valueRank)`
`static DataValue`	`defaultValue(Class<?> compositeClass, UaArrayDimensions arrayDimensions)` Get a new DataValue instance initialized to a default value of javaClass.
`static DataValue`	`defaultValue(Class<?> compositeClass, UnsignedInteger[] arrayDimensions)` Get a new DataValue instance initialized to a default value of javaClass.
`static DataValue`	`defaultValue(EncoderContext encoderContext, UaNodeId dataTypeId)` Get a new DataValue instance initialized to a default value of a DataType.
`static DataValue`	`defaultValue(EncoderContext encoderContext, UaNodeId dataTypeId, int valueRank)`
`static DataValue`	`defaultValue(EncoderContext encoderContext, UaNodeId dataTypeId, UaArrayDimensions arrayDimensions)` Get a new DataValue instance initialized to a default value of a DataType.
`static DataValue`	`defaultValue(EncoderContext encoderContext, UaNodeId dataTypeId, UnsignedInteger[] arrayDimensions)` Get a new DataValue instance initialized to a default value of a DataType.
`boolean`	`equals(Object obj)`
`UnsignedShort`	`getServerPicoseconds()` Getter for the field `serverPicoseconds`.
`DateTime`	`getServerTimestamp()` Getter for the field `serverTimestamp`.
`UnsignedShort`	`getSourcePicoseconds()` Getter for the field `sourcePicoseconds`.
`DateTime`	`getSourceTimestamp()` Getter for the field `sourceTimestamp`.
`StatusCode`	`getStatusCode()` Getter for the field `statusCode`.
`Variant`	`getValue()` Getter for the field `value`.
`int`	`hashCode()`
`boolean`	`isArray()`
`static boolean`	`isArray(DataValue dataValue)` Check if the DataValue contains an array.
`boolean`	`isNull()` Check if Value is null.
`static boolean`	`isNull(DataValue dataValue)` Check if the DataValue is null.
`void`	`setServerPicoseconds(UnsignedShort serverPicoseconds)` Setter for the field `serverPicoseconds`.
`void`	`setServerTimestamp(DateTime serverTimestamp)` Setter for the field `serverTimestamp`.
`void`	`setSourcePicoseconds(UnsignedShort sourcePicoseconds)` Setter for the field `sourcePicoseconds`.
`void`	`setSourceTimestamp(DateTime sourceTimestamp)` Setter for the field `sourceTimestamp`.
`void`	`setStatusCode(StatusCode statusCode)` Set StatusCode of this DataValue.
`void`	`setStatusCode(UnsignedInteger value)` Set StatusCode of this DataValue.
`void`	`setValue(Variant value)` Setter for the field `value`.
`String`	`toString()`

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

- Field Detail
  - ID
```
@Deprecated
public static final NodeId ID
```
    Deprecated. use Identifiers.DataValue instead.
    
    Deprecated.
  - EMPTY_ARRAY
```
public static final DataValue[] EMPTY_ARRAY
```
- Constructor Detail
  - DataValue
```
public DataValue()
```
    Constructor for DataValue.
  - DataValue
```
public DataValue(StatusCode statusCode)
```
    Constructor for DataValue.
    
    Parameters:
    
    statusCode - a StatusCode object.
  - DataValue
```
public DataValue(Variant variant)
```
    Constructor for DataValue.
    
    Parameters:
    
    variant - a Variant object.
  - DataValue
```
public DataValue(Variant value,
                 StatusCode statusCode)
```
    Constructor for DataValue.
    
    Parameters:
    
    value - a Variant object.
    
    statusCode - a StatusCode object.
  - DataValue
```
public DataValue(Variant value,
                 StatusCode statusCode,
                 DateTime sourceTimestamp,
                 DateTime serverTimestamp)
```
    Constructor for DataValue.
    
    Parameters:
    
    value - a Variant object.
    
    statusCode - a StatusCode object.
    
    sourceTimestamp - a DateTime object.
    
    serverTimestamp - a DateTime object.
  - DataValue
```
public DataValue(Variant value,
                 StatusCode statusCode,
                 DateTime sourceTimestamp,
                 UnsignedShort sourcePicoseconds,
                 DateTime serverTimestamp,
                 UnsignedShort serverPicoseconds)
```
    Constructor for DataValue.
    
    Parameters:
    
    value - a Variant object.
    
    statusCode - a StatusCode object.
    
    sourceTimestamp - a DateTime object.
    
    sourcePicoseconds - a UnsignedShort object.
    
    serverTimestamp - a DateTime object.
    
    serverPicoseconds - a UnsignedShort object.
- Method Detail
  - defaultValue
```
public static DataValue defaultValue(Class<?> compositeClass)
```
    Get a new DataValue instance initialized to a default value of javaClass.
    Uses Variant.defaultValue(Class) to create the value.
    
    Parameters:
    
    compositeClass - the class to use to initialize the Variant. Expects that the class is a native JavaClass corresponding to the OPC UA built-in types.
    
    Returns:
    
    a new Variant instance.
  - defaultValue
```
public static DataValue defaultValue(Class<?> compositeClass,
                                     int valueRank)
```
  - defaultValue
```
public static DataValue defaultValue(Class<?> compositeClass,
                                     UaArrayDimensions arrayDimensions)
```
    Get a new DataValue instance initialized to a default value of javaClass.
    Uses Variant#defaultValue(Class, int, UnsignedInteger[]) to create the value.
    
    Parameters:
    
    compositeClass - the class to use to initialize the Variant. Expects that the class is a native JavaClass corresponding to the OPC UA built-in types.
    
    valueRank - the dimension required for the array. If ValueRanks#acceptsScalar(valueRank) a scalar value is always returned.
    
    arrayDimensions - the size of the array in each dimension.
    
    Returns:
    
    a new Variant instance.
  - defaultValue
```
public static DataValue defaultValue(Class<?> compositeClass,
                                     UnsignedInteger[] arrayDimensions)
```
    Get a new DataValue instance initialized to a default value of javaClass.
    Uses Variant#defaultValue(Class, int, UnsignedInteger[]) to create the value.
    
    Parameters:
    
    compositeClass - the class to use to initialize the Variant. Expects that the class is a native JavaClass corresponding to the OPC UA built-in types.
    
    valueRank - the dimension required for the array. If ValueRanks#acceptsScalar(valueRank) a scalar value is always returned.
    
    arrayDimensions - the size of the array in each dimension.
    
    Returns:
    
    a new Variant instance.
  - defaultValue
```
public static DataValue defaultValue(EncoderContext encoderContext,
                                     UaNodeId dataTypeId)
```
    Get a new DataValue instance initialized to a default value of a DataType.
    Uses Variant#defaultValue(UaDataTypeSpecification) to create the value.
    
    Parameters:
    
    encoderContext - the encoder context that can provide the correct DataTypeSpecification for the DataType. Typically, you can get this from the UaApplication instance.
    
    dataTypeId - the NodeId of the OPC UA DataType that you wish to use for (each element of) the default value.
    
    Returns:
    
    a new Variant instance.
  - defaultValue
```
public static DataValue defaultValue(EncoderContext encoderContext,
                                     UaNodeId dataTypeId,
                                     int valueRank)
```
  - defaultValue
```
public static DataValue defaultValue(EncoderContext encoderContext,
                                     UaNodeId dataTypeId,
                                     UaArrayDimensions arrayDimensions)
```
    Get a new DataValue instance initialized to a default value of a DataType.
    Uses Variant#defaultValue(UaDataTypeSpecification, int, UnsignedInteger[]) to create the value.
    
    Parameters:
    
    encoderContext - the encoder context that can provide the correct DataTypeSpecification for the DataType. Typically, you can get this from the UaApplication instance.
    
    dataTypeId - the NodeId of the OPC UA DataType that you wish to use for (each element of) the default value.
    
    valueRank - the dimension required for the array. If ValueRanks#acceptsScalar(valueRank) a scalar value is always returned.
    
    arrayDimensions - the size of the array in each dimension.
    
    Returns:
    
    a new Variant instance.
  - defaultValue
```
public static DataValue defaultValue(EncoderContext encoderContext,
                                     UaNodeId dataTypeId,
                                     UnsignedInteger[] arrayDimensions)
```
    Get a new DataValue instance initialized to a default value of a DataType.
    Uses Variant#defaultValue(UaDataTypeSpecification, int, UnsignedInteger[]) to create the value.
    
    Parameters:
    
    encoderContext - the encoder context that can provide the correct DataTypeSpecification for the DataType. Typically, you can get this from the UaApplication instance.
    
    dataTypeId - the NodeId of the OPC UA DataType that you wish to use for (each element of) the default value.
    
    valueRank - the dimension required for the array. If ValueRanks#acceptsScalar(valueRank) a scalar value is always returned.
    
    arrayDimensions - the size of the array in each dimension.
    
    Returns:
    
    a new Variant instance.
  - isArray
```
public static boolean isArray(DataValue dataValue)
```
    Check if the DataValue contains an array. Checks that dataValue is not null and isArray() is true for it.
  - isNull
```
public static boolean isNull(DataValue dataValue)
```
    Check if the DataValue is null. Checks that dataValue is null or isNull() is true for it.
  - clone
```
public DataValue clone()
```
    Overrides:
    
    clone in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getServerPicoseconds
```
public UnsignedShort getServerPicoseconds()
```
    Getter for the field serverPicoseconds.
    
    Returns:
    
    a UnsignedShort object.
  - getServerTimestamp
```
public DateTime getServerTimestamp()
```
    Getter for the field serverTimestamp.
    
    Returns:
    
    a DateTime object.
  - getSourcePicoseconds
```
public UnsignedShort getSourcePicoseconds()
```
    Getter for the field sourcePicoseconds.
    
    Returns:
    
    a UnsignedShort object.
  - getSourceTimestamp
```
public DateTime getSourceTimestamp()
```
    Getter for the field sourceTimestamp.
    
    Returns:
    
    a DateTime object.
  - getStatusCode
```
public StatusCode getStatusCode()
```
    Getter for the field statusCode.
    
    Returns:
    
    a StatusCode object.
  - getValue
```
public Variant getValue()
```
    Getter for the field value.
    
    Returns:
    
    a Variant object.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isArray
```
public boolean isArray()
```
  - isNull
```
public boolean isNull()
```
    Check if Value is null.
    
    Returns:
    
    true if Value is null or the Variant returned by it contains a null.
  - setServerPicoseconds
```
public void setServerPicoseconds(UnsignedShort serverPicoseconds)
```
    Setter for the field serverPicoseconds.
    
    Parameters:
    
    serverPicoseconds - a UnsignedShort object.
  - setServerTimestamp
```
public void setServerTimestamp(DateTime serverTimestamp)
```
    Setter for the field serverTimestamp.
    
    Parameters:
    
    serverTimestamp - a DateTime object.
  - setSourcePicoseconds
```
public void setSourcePicoseconds(UnsignedShort sourcePicoseconds)
```
    Setter for the field sourcePicoseconds.
    
    Parameters:
    
    sourcePicoseconds - a UnsignedShort object.
  - setSourceTimestamp
```
public void setSourceTimestamp(DateTime sourceTimestamp)
```
    Setter for the field sourceTimestamp.
    
    Parameters:
    
    sourceTimestamp - a DateTime object.
  - setStatusCode
```
public void setStatusCode(StatusCode statusCode)
```
    Set StatusCode of this DataValue. Calling with null is the same effect as with calling StatusCode.GOOD.
  - setStatusCode
```
public void setStatusCode(UnsignedInteger value)
```
    Set StatusCode of this DataValue. Calling with null is the same effect as with calling StatusCode.GOOD.
  - setValue
```
public void setValue(Variant value)
```
    Setter for the field value.
    
    Parameters:
    
    value - a Variant object.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DataValue

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ID

EMPTY_ARRAY

Constructor Detail

DataValue

DataValue

DataValue

DataValue

DataValue

DataValue

Method Detail

defaultValue

defaultValue

defaultValue

defaultValue

defaultValue

defaultValue

defaultValue

defaultValue

isArray

isNull

clone

equals

getServerPicoseconds

getServerTimestamp

getSourcePicoseconds

getSourceTimestamp

getStatusCode

getValue

hashCode

isArray

isNull

setServerPicoseconds

setServerTimestamp

setSourcePicoseconds

setSourceTimestamp

setStatusCode

setStatusCode

setValue

toString