com.prosysopc.ua.nodes

Interface UaValueNode

All Superinterfaces:

UaNode

All Known Subinterfaces:

AlarmRateVariableType, AlarmStateVariableType, AnalogItemType, AnalogUnitRangeType, AnalogUnitType, ArrayItemType, AudioVariableType, BaseAnalogType, BaseDataVariableType, BaseVariableType, BitFieldType, BuildInfoType, CartesianCoordinatesType, ConditionVariableType, CubeItemType, DataItemType, DataTypeDescriptionType, DataTypeDictionaryType, DiscreteItemType, ElseGuardVariableType, ExpressionGuardVariableType, FiniteStateVariableType, FiniteTransitionVariableType, FrameType, GuardVariableType, ImageItemType, MultiStateDictionaryEntryDiscreteBaseType, MultiStateDictionaryEntryDiscreteType, MultiStateDiscreteType, MultiStateValueDiscreteType, NDimensionArrayItemType, OptionSetType, OrientationType, ProgramDiagnostic2Type, ProgramDiagnosticType, PubSubDiagnosticsCounterType, RationalNumberType, ReferenceDescriptionVariableType, SamplingIntervalDiagnosticsArrayType, SamplingIntervalDiagnosticsType, SelectionListType, ServerDiagnosticsSummaryType, ServerStatusType, ServerVendorCapabilityType, SessionDiagnosticsArrayType, SessionDiagnosticsVariableType, SessionSecurityDiagnosticsArrayType, SessionSecurityDiagnosticsType, StateVariableType, SubscriptionDiagnosticsArrayType, SubscriptionDiagnosticsType, ThreeDCartesianCoordinatesType, ThreeDFrameType, ThreeDOrientationType, ThreeDVectorType, TransitionVariableType, TwoStateDiscreteType, TwoStateVariableType, UaProperty, UaVariable, UaVariableType, VectorType, XYArrayItemType, YArrayItemType

All Known Implementing Classes:

AbstractGeneratedVariableNode, AlarmRateVariableTypeImpl, AlarmRateVariableTypeImplBase, AlarmRateVariableTypeNode, AlarmRateVariableTypeNodeBase, AlarmStateVariableTypeImpl, AlarmStateVariableTypeImplBase, AlarmStateVariableTypeNode, AlarmStateVariableTypeNodeBase, AnalogItemTypeImpl, AnalogItemTypeImplBase, AnalogItemTypeNode, AnalogItemTypeNodeBase, AnalogUnitRangeTypeImpl, AnalogUnitRangeTypeImplBase, AnalogUnitRangeTypeNode, AnalogUnitRangeTypeNodeBase, AnalogUnitTypeImpl, AnalogUnitTypeImplBase, AnalogUnitTypeNode, AnalogUnitTypeNodeBase, ArrayItemTypeImpl, ArrayItemTypeImplBase, ArrayItemTypeNode, ArrayItemTypeNodeBase, AudioVariableTypeImpl, AudioVariableTypeImplBase, AudioVariableTypeNode, AudioVariableTypeNodeBase, BaseAnalogTypeImpl, BaseAnalogTypeImplBase, BaseAnalogTypeNode, BaseAnalogTypeNodeBase, BaseDataVariableTypeImpl, BaseDataVariableTypeImplBase, BaseDataVariableTypeNode, BaseDataVariableTypeNodeBase, BaseVariableTypeImpl, BaseVariableTypeNode, BitFieldTypeImpl, BitFieldTypeImplBase, BitFieldTypeNode, BitFieldTypeNodeBase, BuildInfoTypeImpl, BuildInfoTypeImplBase, BuildInfoTypeNode, BuildInfoTypeNodeBase, CacheProperty, CacheVariable, CallbackInstanceProperty, CallbackInstanceVariable, CallbackProperty, CallbackVariable, CartesianCoordinatesTypeImpl, CartesianCoordinatesTypeImplBase, CartesianCoordinatesTypeNode, CartesianCoordinatesTypeNodeBase, ConditionVariableTypeImpl, ConditionVariableTypeImplBase, ConditionVariableTypeNode, ConditionVariableTypeNodeBase, CubeItemTypeImpl, CubeItemTypeImplBase, CubeItemTypeNode, CubeItemTypeNodeBase, DataItemTypeImpl, DataItemTypeImplBase, DataItemTypeNode, DataItemTypeNodeBase, DataTypeDescriptionTypeImpl, DataTypeDescriptionTypeImplBase, DataTypeDescriptionTypeNode, DataTypeDescriptionTypeNodeBase, DataTypeDictionaryTypeImpl, DataTypeDictionaryTypeImplBase, DataTypeDictionaryTypeNode, DataTypeDictionaryTypeNodeBase, DiscreteItemTypeImpl, DiscreteItemTypeImplBase, DiscreteItemTypeNode, DiscreteItemTypeNodeBase, ElseGuardVariableTypeImpl, ElseGuardVariableTypeImplBase, ElseGuardVariableTypeNode, ElseGuardVariableTypeNodeBase, ExpressionGuardVariableTypeImpl, ExpressionGuardVariableTypeImplBase, ExpressionGuardVariableTypeNode, ExpressionGuardVariableTypeNodeBase, FiniteStateVariableTypeImpl, FiniteStateVariableTypeImplBase, FiniteStateVariableTypeNode, FiniteStateVariableTypeNodeBase, FiniteTransitionVariableTypeImpl, FiniteTransitionVariableTypeImplBase, FiniteTransitionVariableTypeNode, FiniteTransitionVariableTypeNodeBase, FrameTypeImpl, FrameTypeImplBase, FrameTypeNode, FrameTypeNodeBase, GuardVariableTypeImpl, GuardVariableTypeImplBase, GuardVariableTypeNode, GuardVariableTypeNodeBase, ImageItemTypeImpl, ImageItemTypeImplBase, ImageItemTypeNode, ImageItemTypeNodeBase, InstanceVariable, MultiStateDictionaryEntryDiscreteBaseTypeImpl, MultiStateDictionaryEntryDiscreteBaseTypeImplBase, MultiStateDictionaryEntryDiscreteBaseTypeNode, MultiStateDictionaryEntryDiscreteBaseTypeNodeBase, MultiStateDictionaryEntryDiscreteTypeImpl, MultiStateDictionaryEntryDiscreteTypeImplBase, MultiStateDictionaryEntryDiscreteTypeNode, MultiStateDictionaryEntryDiscreteTypeNodeBase, MultiStateDiscreteTypeImpl, MultiStateDiscreteTypeImplBase, MultiStateDiscreteTypeNode, MultiStateDiscreteTypeNodeBase, MultiStateValueDiscreteTypeImpl, MultiStateValueDiscreteTypeImplBase, MultiStateValueDiscreteTypeNode, MultiStateValueDiscreteTypeNodeBase, NDimensionArrayItemTypeImpl, NDimensionArrayItemTypeImplBase, NDimensionArrayItemTypeNode, NDimensionArrayItemTypeNodeBase, OptionSetTypeImpl, OptionSetTypeImplBase, OptionSetTypeNode, OptionSetTypeNodeBase, OrientationTypeImpl, OrientationTypeImplBase, OrientationTypeNode, OrientationTypeNodeBase, PlainInstanceProperty, PlainInstanceVariable, PlainProperty, PlainVariable, ProgramDiagnostic2TypeImpl, ProgramDiagnostic2TypeImplBase, ProgramDiagnostic2TypeNode, ProgramDiagnostic2TypeNodeBase, ProgramDiagnosticTypeImpl, ProgramDiagnosticTypeImplBase, ProgramDiagnosticTypeNode, ProgramDiagnosticTypeNodeBase, PubSubDiagnosticsCounterTypeImpl, PubSubDiagnosticsCounterTypeImplBase, PubSubDiagnosticsCounterTypeNode, PubSubDiagnosticsCounterTypeNodeBase, RationalNumberTypeImpl, RationalNumberTypeImplBase, RationalNumberTypeNode, RationalNumberTypeNodeBase, ReferenceDescriptionVariableTypeImpl, ReferenceDescriptionVariableTypeImplBase, ReferenceDescriptionVariableTypeNode, ReferenceDescriptionVariableTypeNodeBase, ReflectiveInstanceProperty, ReflectiveInstanceVariable, ReflectiveProperty, ReflectiveVariable, SamplingIntervalDiagnosticsArrayTypeImpl, SamplingIntervalDiagnosticsArrayTypeImplBase, SamplingIntervalDiagnosticsArrayTypeNode, SamplingIntervalDiagnosticsArrayTypeNodeBase, SamplingIntervalDiagnosticsTypeImpl, SamplingIntervalDiagnosticsTypeImplBase, SamplingIntervalDiagnosticsTypeNode, SamplingIntervalDiagnosticsTypeNodeBase, SelectionListTypeImpl, SelectionListTypeImplBase, SelectionListTypeNode, SelectionListTypeNodeBase, ServerDiagnosticsSummaryTypeImpl, ServerDiagnosticsSummaryTypeImplBase, ServerDiagnosticsSummaryTypeNode, ServerDiagnosticsSummaryTypeNodeBase, ServerStatusTypeImpl, ServerStatusTypeImplBase, ServerStatusTypeNode, ServerStatusTypeNodeBase, ServerVendorCapabilityTypeImpl, ServerVendorCapabilityTypeImplBase, ServerVendorCapabilityTypeNode, ServerVendorCapabilityTypeNodeBase, SessionDiagnosticsArrayTypeImpl, SessionDiagnosticsArrayTypeImplBase, SessionDiagnosticsArrayTypeNode, SessionDiagnosticsArrayTypeNodeBase, SessionDiagnosticsVariableTypeImpl, SessionDiagnosticsVariableTypeImplBase, SessionDiagnosticsVariableTypeNode, SessionDiagnosticsVariableTypeNodeBase, SessionSecurityDiagnosticsArrayTypeImpl, SessionSecurityDiagnosticsArrayTypeImplBase, SessionSecurityDiagnosticsArrayTypeNode, SessionSecurityDiagnosticsArrayTypeNodeBase, SessionSecurityDiagnosticsTypeImpl, SessionSecurityDiagnosticsTypeImplBase, SessionSecurityDiagnosticsTypeNode, SessionSecurityDiagnosticsTypeNodeBase, StateVariableTypeImpl, StateVariableTypeImplBase, StateVariableTypeNode, StateVariableTypeNodeBase, SubscriptionDiagnosticsArrayTypeImpl, SubscriptionDiagnosticsArrayTypeImplBase, SubscriptionDiagnosticsArrayTypeNode, SubscriptionDiagnosticsArrayTypeNodeBase, SubscriptionDiagnosticsTypeImpl, SubscriptionDiagnosticsTypeImplBase, SubscriptionDiagnosticsTypeNode, SubscriptionDiagnosticsTypeNodeBase, ThreeDCartesianCoordinatesTypeImpl, ThreeDCartesianCoordinatesTypeImplBase, ThreeDCartesianCoordinatesTypeNode, ThreeDCartesianCoordinatesTypeNodeBase, ThreeDFrameTypeImpl, ThreeDFrameTypeImplBase, ThreeDFrameTypeNode, ThreeDFrameTypeNodeBase, ThreeDOrientationTypeImpl, ThreeDOrientationTypeImplBase, ThreeDOrientationTypeNode, ThreeDOrientationTypeNodeBase, ThreeDVectorTypeImpl, ThreeDVectorTypeImplBase, ThreeDVectorTypeNode, ThreeDVectorTypeNodeBase, TransitionVariableTypeImpl, TransitionVariableTypeImplBase, TransitionVariableTypeNode, TransitionVariableTypeNodeBase, TwoStateDiscreteTypeImpl, TwoStateDiscreteTypeImplBase, TwoStateDiscreteTypeNode, TwoStateDiscreteTypeNodeBase, TwoStateVariableTypeImpl, TwoStateVariableTypeImplBase, TwoStateVariableTypeNode, TwoStateVariableTypeNodeBase, UaPropertyImpl, UaVariableImpl, UaVariableNode, UaVariableTypeImpl, UaVariableTypeNode, VectorTypeImpl, VectorTypeImplBase, VectorTypeNode, VectorTypeNodeBase, XYArrayItemTypeImpl, XYArrayItemTypeImplBase, XYArrayItemTypeNode, XYArrayItemTypeNodeBase, YArrayItemTypeImpl, YArrayItemTypeImplBase, YArrayItemTypeNode, YArrayItemTypeNodeBase

public interface UaValueNode
extends UaNode

A common interface for UaVariable and UaVariableType. Defines support for the Value property in the nodes.

Nested Class Summary

Nested classes/interfaces inherited from interface com.prosysopc.ua.nodes.UaNode

UaNode.Parameters

Method Summary

Modifier and Type	Method and Description
UnsignedInteger[]	getArrayDimensions() This Attribute specifies the length of each dimension for an array value.
UaDataType	getDataType()
NodeId	getDataTypeId()
DataValue	getValue()
Integer	getValueRank() This Attribute indicates whether the Value Attribute of the Variable is an array and how many dimensions the array has.
void	setArrayDimensions(UnsignedInteger[] ArrayDimensions) This Attribute specifies the length of each dimension for an array value.
void	setDataType(UaDataType dataType) Set the Data Type node.
void	setDataTypeId(NodeId dataTypeId) Set the Data Type.
void	setValue(DataValue value) The default Value for instances of this type.
void	setValue(Object value) Set value.
void	setValueRank(int valueRank) This Attribute indicates whether the Value Attribute of the VariableType is an array and how many dimensions the array has.

Methods inherited from interface com.prosysopc.ua.nodes.UaNode

addComponent, addOrganizes, addProperty, addReference, addReference, addReference, addReference, addReference, addReference, deleteReference, deleteReference, deleteReference, deleteReference, getAddressSpace, getAttributes, getAttributesMap, getBrowseName, getBrowsePaths, getComponent, getComponents, getDescription, getDisplayName, getForwardReferences, getInverseReferences, getMethod, getNodeClass, getNodeId, getNodeVersionNode, getOrganizedNode, getOrganizedNodes, getProperties, getProperty, getReference, getReferences, getReferences, getSupportedAttributes, getUaBrowsePaths, getUaNodeId, getUserData, getUserWriteMask, getWriteMask, hasUserWriteAccess, hasWriteAccess, readAttribute, readAttribute, removeComponent, removeProperty, setAttribute, setAttributes, setBrowseName, setDescription, setDisplayName, setReferences, setUserData, setUserWriteMask, setWriteMask, supportsAttribute, writeAttribute

Method Detail

getArrayDimensions

UnsignedInteger[] getArrayDimensions()

This Attribute specifies the length of each dimension for an array value. The Attribute is intended to describe the capability of the Variable, not the current size.

The number of elements shall be equal to the value of the ValueRank Attribute. Shall be null if ValueRank <= 0.

A value of 0 for an individual dimension indicates that the dimension has a variable length.

For example, if a Variable is defined by the following C array: Int32 myArray[346];

then this Variable's DataType would point to an Int32, the Variable's ValueRank has the value 1 and the ArrayDimensions is an array with one entry having the value 346.

Returns:

the array dimensions of the variable type or null if this is not a specific array type, i.e. ValueRank <= 0

See Also:

setArrayDimensions(com.prosysopc.ua.stack.builtintypes.UnsignedInteger[])

getDataType

UaDataType getDataType()

Returns:

the DataType node, if set.

See Also:

getDataTypeId()

getDataTypeId

NodeId getDataTypeId()

Returns:

NodeId of the data type definition for instances of this type.

getValue

DataValue getValue()

Returns:

The default Value for instances of this type.

getValueRank

Integer getValueRank()

This Attribute indicates whether the Value Attribute of the Variable is an array and how many dimensions the array has.

It may have the following values:

• n>1: the Value is an array with the specified number of dimensions.
• OneDimension (1): The value is an array with one dimension.
• OneOrMoreDimensions (0): The value is an array with one or more dimensions.
• Scalar (-1): The value is not an array.
• Any (-2): The value can be a scalar or an array with any number of dimensions.
• ScalarOrOneDimension (-3): The value can be a scalar or a one dimensional array.

Returns:

the value rank

See Also:

setValueRank(int)

setArrayDimensions

void setArrayDimensions(UnsignedInteger[] ArrayDimensions)

This Attribute specifies the length of each dimension for an array value. The Attribute is intended to describe the capability of the VariableType, not the current size.

The number of elements shall be equal to the value of the ValueRank Attribute. Shall be null if ValueRank <= 0.

A value of 0 for an individual dimension indicates that the dimension has a variable length.

For example, if a VariableType is defined by the following array:

Integer[] myArray = new Integer[346];

then this VariableType's DataType would point to the Int32 data type node, the VariableType's ValueRank has the value 1 and the ArrayDimensions is an array with one entry having the value 346.

Parameters:

ArrayDimensions -

setDataType

void setDataType(UaDataType dataType)

Set the Data Type node.

Parameters:

dataType -

See Also:

setDataTypeId(NodeId)

setDataTypeId

void setDataTypeId(NodeId dataTypeId)

Set the Data Type.

Parameters:

dataTypeId -

See Also:

setDataTypeId(NodeId)

setValue

void setValue(DataValue value)
       throws StatusException

The default Value for instances of this type.

Parameters:

value - the default value to set

Throws:

StatusException

setValue

void setValue(Object value)
       throws StatusException

Set value.

Parameters:

value - a new value

Throws:

StatusException - if the value is invalid for the Value attribute

setValueRank

void setValueRank(int valueRank)

This Attribute indicates whether the Value Attribute of the VariableType is an array and how many dimensions the array has.

It may have the following values:

• n>1: the Value is an array with the specified number of dimensions.
• OneDimension (1): The value is an array with one dimension.
• OneOrMoreDimensions (0): The value is an array with one or more dimensions.
• Scalar (-1): The value is not an array.
• Any (-2): The value can be a scalar or an array with any number of dimensions.
• ScalarOrOneDimension (-3): The value can be a scalar or a one dimensional array.

Parameters:

valueRank - the value rank to set