com.prosysopc.ua.nodes

Interface UaVariable

All Superinterfaces:

UaInstance, UaNode, UaValueNode

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, 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, VectorTypeImpl, VectorTypeImplBase, VectorTypeNode, VectorTypeNodeBase, XYArrayItemTypeImpl, XYArrayItemTypeImplBase, XYArrayItemTypeNode, XYArrayItemTypeNodeBase, YArrayItemTypeImpl, YArrayItemTypeImplBase, YArrayItemTypeNode, YArrayItemTypeNodeBase

public interface UaVariable
extends UaInstance, UaValueNode

UaVariable defines the interface for the UA variable.

Variables are used to represent values which may be simple or complex. The TypeDefinition of a variable should point to a UaVariableType.

Variables are either Properties or DataVariables of other Nodes in the AddressSpace. A Variable must be related to one or many nodes using references. They may not exist independently.They are never defined by themselves.

The variables may be scalar or array type and may contain any number of properties which define specific capability. The properties may be defined in the TypeDefinition or solely in a single variable instance.

See Also:

UaVariableType, UaObject, UaDataType

Nested Class Summary

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

UaNode.Parameters

Method Summary

Modifier and Type	Method and Description
void	addDataChangeListener(DataChangeListener listener)
AccessLevelType	getAccessLevel() Defines the global read/write access of the Value attribute for all users.
Boolean	getHistorizing()
Double	getMinimumSamplingInterval()
AccessLevelType	getUserAccessLevel() Defines the user specific read/write access of the Value attribute.
void	removeDataChangeListener(DataChangeListener listener)
void	setAccessLevel(AccessLevelType accessLevel)
void	setHistorizing(Boolean historizing)
void	setMinimumSamplingInterval(Double minimumSamplingInterval)
void	setUserAccessLevel(AccessLevelType userAccessLevel)

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

getTypeDefinition, getTypeDefinitionId, setTypeDefinition, setTypeDefinitionId, setTypeDefinitionId

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

getArrayDimensions, getDataType, getDataTypeId, getValue, getValueRank, setArrayDimensions, setDataType, setDataTypeId, setValue, setValue, setValueRank

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

addDataChangeListener

void addDataChangeListener(DataChangeListener listener)

getAccessLevel

AccessLevelType getAccessLevel()

Defines the global read/write access of the Value attribute for all users.

In contrast to the WriteAccess this attribute only applies to the Value attribute.

Returns:

the current global access rights

See Also:

getUserAccessLevel()

getHistorizing

Boolean getHistorizing()

Returns:

whether the variable has history

getMinimumSamplingInterval

Double getMinimumSamplingInterval()

Returns:

the minimum sampling interval that the server supports for the variable

getUserAccessLevel

AccessLevelType getUserAccessLevel()

Defines the user specific read/write access of the Value attribute.

In contrast to the UserWriteAccess this attribute only applies to the Value attribute.

Returns:

the current access rights for the user that requested it

See Also:

getAccessLevel()

removeDataChangeListener

void removeDataChangeListener(DataChangeListener listener)

setAccessLevel

void setAccessLevel(AccessLevelType accessLevel)

Parameters:

accessLevel - the access level to set

See Also:

getAccessLevel()

setHistorizing

void setHistorizing(Boolean historizing)

Parameters:

historizing - define that the variable has history - or not

setMinimumSamplingInterval

void setMinimumSamplingInterval(Double minimumSamplingInterval)

Parameters:

minimumSamplingInterval - define the minimum sampling interval

setUserAccessLevel

void setUserAccessLevel(AccessLevelType userAccessLevel)

Parameters:

userAccessLevel - the user access level to set

See Also:

getUserAccessLevel()