Enum UaAttributes

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AccessLevel
      Bitmask indicating how a variable may be accessed — read, write, history (attribute id 17).
      AccessLevelEx
      Extended access level bitmask with additional flags beyond AccessLevel (attribute id 27).
      AccessRestrictions
      The access restrictions assigned to the node (attribute id 26).
      ArrayDimensions
      The length for each dimension of an array value (attribute id 16).
      BrowseName
      A non-localized, human-readable qualified name for the node (attribute id 3).
      ContainsNoLoops
      Whether following forward references within a View will not cause a loop (attribute id 11).
      DataType
      The NodeId of the data type for the variable value (attribute id 14).
      DataTypeDefinition
      Metadata and encoding information for custom DataTypes (attribute id 23).
      Description
      A localized description for the node (attribute id 5).
      DisplayName
      A localized, human-readable name for the node (attribute id 4).
      EventNotifier
      Bitmask indicating whether the node supports event subscriptions (attribute id 12).
      Executable
      Whether the method can be called (attribute id 21).
      Historizing
      Whether the server is actively collecting historical data for this variable (attribute id 20).
      InverseName
      The localized browse name used when following a reference in the inverse direction (attribute id 10).
      IsAbstract
      Whether a type node is abstract and cannot be instantiated directly (attribute id 8).
      MinimumSamplingInterval
      The fastest rate in milliseconds at which the server can sample the value for changes (attribute id 19).
      NodeClass
      The class of the node such as Object, Variable, or Method (attribute id 2).
      NodeId
      The canonical identifier for the node (attribute id 1).
      RolePermissions
      The permissions for the node granted to roles (attribute id 24).
      Symmetric
      Whether forward and inverse references have the same semantic meaning (attribute id 9).
      UserAccessLevel
      Bitmask indicating how a variable may be accessed by the current user (attribute id 18).
      UserExecutable
      Whether the method can be called by the current user (attribute id 22).
      UserRolePermissions
      The subset of permissions available for the roles of the current session (attribute id 25).
      UserWriteMask
      Bitmask indicating which attributes are writable by the current user (attribute id 7).
      Value
      The current value of a variable node (attribute id 13).
      ValueRank
      The number of dimensions in the value; -1 for scalar (attribute id 15).
      WriteMask
      Bitmask indicating which attributes are writable (attribute id 6).
    • Enum Constant Detail

      • NodeId

        public static final UaAttributes NodeId
        The canonical identifier for the node (attribute id 1).
      • NodeClass

        public static final UaAttributes NodeClass
        The class of the node such as Object, Variable, or Method (attribute id 2).
      • BrowseName

        public static final UaAttributes BrowseName
        A non-localized, human-readable qualified name for the node (attribute id 3).
      • DisplayName

        public static final UaAttributes DisplayName
        A localized, human-readable name for the node (attribute id 4).
      • Description

        public static final UaAttributes Description
        A localized description for the node (attribute id 5).
      • WriteMask

        public static final UaAttributes WriteMask
        Bitmask indicating which attributes are writable (attribute id 6).
      • UserWriteMask

        public static final UaAttributes UserWriteMask
        Bitmask indicating which attributes are writable by the current user (attribute id 7).
      • IsAbstract

        public static final UaAttributes IsAbstract
        Whether a type node is abstract and cannot be instantiated directly (attribute id 8).
      • Symmetric

        public static final UaAttributes Symmetric
        Whether forward and inverse references have the same semantic meaning (attribute id 9).
      • InverseName

        public static final UaAttributes InverseName
        The localized browse name used when following a reference in the inverse direction (attribute id 10).
      • ContainsNoLoops

        public static final UaAttributes ContainsNoLoops
        Whether following forward references within a View will not cause a loop (attribute id 11).
      • EventNotifier

        public static final UaAttributes EventNotifier
        Bitmask indicating whether the node supports event subscriptions (attribute id 12).
      • Value

        public static final UaAttributes Value
        The current value of a variable node (attribute id 13).
      • DataType

        public static final UaAttributes DataType
        The NodeId of the data type for the variable value (attribute id 14).
      • ValueRank

        public static final UaAttributes ValueRank
        The number of dimensions in the value; -1 for scalar (attribute id 15).
      • ArrayDimensions

        public static final UaAttributes ArrayDimensions
        The length for each dimension of an array value (attribute id 16).
      • AccessLevel

        public static final UaAttributes AccessLevel
        Bitmask indicating how a variable may be accessed — read, write, history (attribute id 17).
      • UserAccessLevel

        public static final UaAttributes UserAccessLevel
        Bitmask indicating how a variable may be accessed by the current user (attribute id 18).
      • MinimumSamplingInterval

        public static final UaAttributes MinimumSamplingInterval
        The fastest rate in milliseconds at which the server can sample the value for changes (attribute id 19).
      • Historizing

        public static final UaAttributes Historizing
        Whether the server is actively collecting historical data for this variable (attribute id 20).
      • Executable

        public static final UaAttributes Executable
        Whether the method can be called (attribute id 21).
      • UserExecutable

        public static final UaAttributes UserExecutable
        Whether the method can be called by the current user (attribute id 22).
      • DataTypeDefinition

        public static final UaAttributes DataTypeDefinition
        Metadata and encoding information for custom DataTypes (attribute id 23).
      • RolePermissions

        public static final UaAttributes RolePermissions
        The permissions for the node granted to roles (attribute id 24).
      • UserRolePermissions

        public static final UaAttributes UserRolePermissions
        The subset of permissions available for the roles of the current session (attribute id 25).
      • AccessRestrictions

        public static final UaAttributes AccessRestrictions
        The access restrictions assigned to the node (attribute id 26).
      • AccessLevelEx

        public static final UaAttributes AccessLevelEx
        Extended access level bitmask with additional flags beyond AccessLevel (attribute id 27).
    • Method Detail

      • values

        public static UaAttributes[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (UaAttributes c : UaAttributes.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static UaAttributes valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • getValue

        public com.plccom.opc.ua.builtintypes.UnsignedInteger getValue()
        enum int value
        Returns:
        return int enum value
      • getEnumMember

        public static String[] getEnumMember()
        returns the enum member as Array of Strings
        Returns:
        String[]
      • contains

        public static boolean contains​(String searchfor)
        function checks if a given enum value valid or not
        Parameters:
        searchfor - the string identifier of the enum member
        Returns:
        returns true if the given enum member valid, otherwise false
      • contains

        public static boolean contains​(com.plccom.opc.ua.builtintypes.UnsignedInteger searchfor)
        function checks if a given enum value valid or not
        Parameters:
        searchfor - the UnsignedInteger identifier of the enum member
        Returns:
        returns true if the given enum member valid, otherwise false
      • valueOf

        public static UaAttributes valueOf​(com.plccom.opc.ua.builtintypes.UnsignedInteger value)
        Returns the enum constant for the given OPC UA attribute identifier.
        Parameters:
        value - the numeric attribute identifier (1–27)
        Returns:
        the matching enum constant, or null if the value is not a known attribute