com.prosysopc.ua.nodes
Interface UaVariable

All Superinterfaces:
UaInstance, UaNode, UaValueNode
All Known Subinterfaces:
AnalogItemType, ArrayItemType, BaseDataVariableType, BaseVariableType, BuildInfoType, ChemometricModelType, ConditionVariableType, CubeItemType, DataItemType, DataTypeDescriptionType, DataTypeDictionaryType, DiscreteItemType, EngineeringValueType, FiniteStateVariableType, FiniteTransitionVariableType, ImageItemType, MultiStateDiscreteType, MultiStateValueDiscreteType, MVAModelType, MVAOutputParameterType, NDimensionArrayItemType, OptionSetType, ProcessVariableType, ProgramDiagnosticType, SamplingIntervalDiagnosticsArrayType, SamplingIntervalDiagnosticsType, ServerDiagnosticsSummaryType, ServerStatusType, ServerVendorCapabilityType, SessionDiagnosticsArrayType, SessionDiagnosticsVariableType, SessionSecurityDiagnosticsArrayType, SessionSecurityDiagnosticsType, StateVariableType, SubscriptionDiagnosticsArrayType, SubscriptionDiagnosticsType, TransitionVariableType, TwoStateDiscreteType, TwoStateVariableType, UaProperty, UIElementType, XYArrayItemType, YArrayItemType
All Known Implementing Classes:
AbstractGeneratedVariableNode, AnalogItemTypeImpl, AnalogItemTypeImplBase, AnalogItemTypeNode, AnalogItemTypeNodeBase, ArrayItemTypeImpl, ArrayItemTypeImplBase, ArrayItemTypeNode, ArrayItemTypeNodeBase, BaseDataVariableTypeImpl, BaseDataVariableTypeImplBase, BaseDataVariableTypeNode, BaseDataVariableTypeNodeBase, BaseVariableTypeImpl, BaseVariableTypeNode, BuildInfoTypeImpl, BuildInfoTypeImplBase, BuildInfoTypeNode, BuildInfoTypeNodeBase, CacheProperty, CacheVariable, CallbackInstanceProperty, CallbackInstanceVariable, CallbackProperty, CallbackVariable, ChemometricModelTypeImpl, ChemometricModelTypeImplBase, ChemometricModelTypeNode, ChemometricModelTypeNodeBase, ConditionVariableTypeImpl, ConditionVariableTypeImplBase, ConditionVariableTypeNode, ConditionVariableTypeNodeBase, CubeItemTypeImpl, CubeItemTypeImplBase, CubeItemTypeNode, CubeItemTypeNodeBase, DataItemTypeImpl, DataItemTypeImplBase, DataItemTypeNode, DataItemTypeNodeBase, DataTypeDescriptionTypeImpl, DataTypeDescriptionTypeImplBase, DataTypeDescriptionTypeNode, DataTypeDescriptionTypeNodeBase, DataTypeDictionaryTypeImpl, DataTypeDictionaryTypeImplBase, DataTypeDictionaryTypeNode, DataTypeDictionaryTypeNodeBase, DiscreteItemTypeImpl, DiscreteItemTypeImplBase, DiscreteItemTypeNode, DiscreteItemTypeNodeBase, EngineeringValueTypeImpl, EngineeringValueTypeImplBase, EngineeringValueTypeNode, EngineeringValueTypeNodeBase, FiniteStateVariableTypeImpl, FiniteStateVariableTypeImplBase, FiniteStateVariableTypeNode, FiniteStateVariableTypeNodeBase, FiniteTransitionVariableTypeImpl, FiniteTransitionVariableTypeImplBase, FiniteTransitionVariableTypeNode, FiniteTransitionVariableTypeNodeBase, ImageItemTypeImpl, ImageItemTypeImplBase, ImageItemTypeNode, ImageItemTypeNodeBase, InstanceVariable, MultiStateDiscreteTypeImpl, MultiStateDiscreteTypeImplBase, MultiStateDiscreteTypeNode, MultiStateDiscreteTypeNodeBase, MultiStateValueDiscreteTypeImpl, MultiStateValueDiscreteTypeImplBase, MultiStateValueDiscreteTypeNode, MultiStateValueDiscreteTypeNodeBase, MVAModelTypeImpl, MVAModelTypeImplBase, MVAModelTypeNode, MVAModelTypeNodeBase, MVAOutputParameterTypeImpl, MVAOutputParameterTypeImplBase, MVAOutputParameterTypeNode, MVAOutputParameterTypeNodeBase, NDimensionArrayItemTypeImpl, NDimensionArrayItemTypeImplBase, NDimensionArrayItemTypeNode, NDimensionArrayItemTypeNodeBase, OptionSetTypeImpl, OptionSetTypeImplBase, OptionSetTypeNode, OptionSetTypeNodeBase, PlainInstanceProperty, PlainInstanceVariable, PlainProperty, PlainVariable, ProcessVariableTypeImpl, ProcessVariableTypeImplBase, ProcessVariableTypeNode, ProcessVariableTypeNodeBase, ProgramDiagnosticTypeImpl, ProgramDiagnosticTypeImplBase, ProgramDiagnosticTypeNode, ProgramDiagnosticTypeNodeBase, ReflectiveInstanceProperty, ReflectiveInstanceVariable, ReflectiveProperty, ReflectiveVariable, SamplingIntervalDiagnosticsArrayTypeImpl, SamplingIntervalDiagnosticsArrayTypeImplBase, SamplingIntervalDiagnosticsArrayTypeNode, SamplingIntervalDiagnosticsArrayTypeNodeBase, SamplingIntervalDiagnosticsTypeImpl, SamplingIntervalDiagnosticsTypeImplBase, SamplingIntervalDiagnosticsTypeNode, SamplingIntervalDiagnosticsTypeNodeBase, 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, TransitionVariableTypeImpl, TransitionVariableTypeImplBase, TransitionVariableTypeNode, TransitionVariableTypeNodeBase, TwoStateDiscreteTypeImpl, TwoStateDiscreteTypeImplBase, TwoStateDiscreteTypeNode, TwoStateDiscreteTypeNodeBase, TwoStateVariableTypeImpl, TwoStateVariableTypeImplBase, TwoStateVariableTypeNode, TwoStateVariableTypeNodeBase, UaPropertyImpl, UaVariableImpl, UaVariableNode, UIElementTypeImpl, UIElementTypeImplBase, UIElementTypeNode, UIElementTypeNodeBase, 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

Method Summary
 void addDataChangeListener(DataChangeListener listener)
           
 EnumSet<org.opcfoundation.ua.core.AccessLevel> getAccessLevel()
          Defines the global read/write access of the Value attribute for all users.
 Boolean getHistorizing()
           
 Double getMinimumSamplingInterval()
           
 EnumSet<org.opcfoundation.ua.core.AccessLevel> getUserAccessLevel()
          Defines the user specific read/write access of the Value attribute.
 void removeDataChangeListener(DataChangeListener listener)
           
 void setAccessLevel(EnumSet<org.opcfoundation.ua.core.AccessLevel> accessLevel)
           
 void setHistorizing(Boolean historizing)
           
 void setMinimumSamplingInterval(Double minimumSamplingInterval)
           
 void setUserAccessLevel(EnumSet<org.opcfoundation.ua.core.AccessLevel> 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, addProperty, addReference, addReference, addReference, deleteReference, deleteReference, deleteReference, deleteReference, getAddressSpace, getAttributes, getBrowseName, getComponent, getComponents, getDescription, getDisplayName, getForwardReferences, getInverseReferences, getMethod, getNodeClass, getNodeId, getNodeVersion, getProperties, getProperty, getReference, getReferences, getReferences, getSupportedAttributes, getUserWriteMask, getWriteMask, hasUserWriteAccess, hasWriteAccess, readAttribute, readAttribute, removeComponent, removeProperty, setAttribute, setAttributes, setBrowseName, setDescription, setDisplayName, setReferences, setUserWriteMask, setWriteMask, supportsAttribute, writeAttribute
 

Method Detail

addDataChangeListener

void addDataChangeListener(DataChangeListener listener)

getAccessLevel

EnumSet<org.opcfoundation.ua.core.AccessLevel> 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

EnumSet<org.opcfoundation.ua.core.AccessLevel> 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(EnumSet<org.opcfoundation.ua.core.AccessLevel> 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(EnumSet<org.opcfoundation.ua.core.AccessLevel> userAccessLevel)
Parameters:
userAccessLevel - the user access level to set
See Also:
getUserAccessLevel()


Copyright © 2018. All rights reserved.