org.eclipse.milo.opcua.sdk.core.nodes

Class VariableNodeProperties

java.lang.Object

org.eclipse.milo.opcua.sdk.core.nodes.VariableNodeProperties

public final class VariableNodeProperties
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<Boolean>	AllowNulls The AllowNulls Property is only used for DataVariables.
static QualifiedProperty<String>	DataTypeVersion Only used for Variables of the VariableType DataTypeDictionaryType and DataTypeDescriptionType as described in OPC UA Part 5, section 5.18.
static QualifiedProperty<ByteString>	DictionaryFragment Only used for Variables of the VariableType DataTypeDescriptionType as described in OPC UA Part 5, section 5.18.
static QualifiedProperty<EUInformation>	EngineeringUnits Only used for DataVariables having a Number DataType.
static QualifiedProperty<TimeZoneDataType>	LocalTime The LocalTime Property is only used for DataVariables.
static QualifiedProperty<UInteger>	MaxArrayLength Only used for DataVariables having its ValueRank Attribute not set to scalar.
static QualifiedProperty<UInteger>	MaxStringLength Only used for DataVariables having a String DataType.
static QualifiedProperty<String>	NodeVersion The NodeVersion Property is used to indicate the version of a Node.
static QualifiedProperty<LocalizedText>	ValueAsText Only used for DataVariables having an Enumeration DataType.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NodeVersion

public static final QualifiedProperty<String> NodeVersion

The NodeVersion Property is used to indicate the version of a Node. It does not apply to Properties.

The NodeVersion Property is updated each time a Reference is added or removed from the Node the Property belongs to.

Although the relationship of a Variable to its DataType is not modelled using References, changes to the DataType Attribute of a Variable lead to an update of the NodeVersion Property.

The usage of this Property is optional.

LocalTime

public static final QualifiedProperty<TimeZoneDataType> LocalTime

The LocalTime Property is only used for DataVariables. It does not apply to Properties.

This Property is a structure containing the Offset and the DaylightSavingInOffset flag. The Offset specifies the time difference (in minutes) between the SourceTimestamp (UTC) associated with the value and the time at the location in which the value was obtained. If DaylightSavingInOffset is TRUE, then Standard/Daylight savings time (DST) at the originating location is in effect and Offset includes the DST correction. If FALSE then the Offset does not include DST correction and DST may or may not have been in effect.

The usage of this Property is optional.

DataTypeVersion

public static final QualifiedProperty<String> DataTypeVersion

Only used for Variables of the VariableType DataTypeDictionaryType and DataTypeDescriptionType as described in OPC UA Part 5, section 5.18.

The usage of this Property is optional.

DictionaryFragment

public static final QualifiedProperty<ByteString> DictionaryFragment

Only used for Variables of the VariableType DataTypeDescriptionType as described in OPC UA Part 5, section 5.18.

The usage of this Property is optional.

AllowNulls

public static final QualifiedProperty<Boolean> AllowNulls

The AllowNulls Property is only used for DataVariables. It does not apply to Properties.

This Property specifies if a null value is allowed for the Value Attribute of the DataVariable. If it is set to true, the Server may return null values and accept writing of null values. If it is set to false, the Server shall never return a null value and shall reject any request writing a null value.

If this Property is not provided, it is Server-specific if null values are allowed or not.

The usage of this Property is optional.

ValueAsText

public static final QualifiedProperty<LocalizedText> ValueAsText

Only used for DataVariables having an Enumeration DataType.

This optional Property provides the localized text representation of the enumeration value. It can be used by Clients only interested in displaying the text to subscribe to the Property instead of the value attribute.

The usage of this Property is optional.

MaxStringLength

public static final QualifiedProperty<UInteger> MaxStringLength

Only used for DataVariables having a String DataType.

This optional Property indicates the maximum number of characters supported by the DataVariable.

The usage of this Property is optional.

MaxArrayLength

public static final QualifiedProperty<UInteger> MaxArrayLength

Only used for DataVariables having its ValueRank Attribute not set to scalar.

This optional Property indicates the maximum length of an array supported by the DataVariable. In a multidimensional array it indicates the overall length.

NOTE: In order to expose the length of an array of bytes do not use the DataType ByteString but an array of the DataType Byte. In that case the MaxArrayLength applies.

The usage of this Property is optional.

EngineeringUnits

public static final QualifiedProperty<EUInformation> EngineeringUnits

Only used for DataVariables having a Number DataType.

This optional Property indicates the engineering units for the value of the DataVariable (e.g. hertz or seconds). Details about the Property and what engineering units should be used are defined in Part 8. The DataType EUInformation is also defined in Part 8.

The usage of this Property is optional.