Module org.eclipse.milo.opcua.sdk.client
Package org.eclipse.milo.opcua.sdk.client.model.variables

Interface BitFieldType

All Superinterfaces:
BaseDataVariableType, BaseVariableType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode
All Known Implementing Classes:
BitFieldTypeNode
public interface BitFieldType extends BaseDataVariableType
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[]>
    BIT_FIELDS_DEFINITIONS
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[]
    getBitFieldsDefinitions()
    Get the local value of the BitFieldsDefinitions Node.
    PropertyType
    getBitFieldsDefinitionsNode()
    Get the BitFieldsDefinitions PropertyType Node, or null if it does not exist.
    CompletableFuture<? extends PropertyType>
    getBitFieldsDefinitionsNodeAsync()
    Asynchronous implementation of getBitFieldsDefinitionsNode().
    org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[]
    readBitFieldsDefinitions()
    Read the value of the BitFieldsDefinitions Node from the server and update the local value if the operation succeeds.
    CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[]>
    readBitFieldsDefinitionsAsync()
    An asynchronous implementation of readBitFieldsDefinitions().
    void
    setBitFieldsDefinitions(org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[] value)
    Set the local value of the BitFieldsDefinitions Node.
    void
    writeBitFieldsDefinitions(org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[] value)
    Write a new value for the BitFieldsDefinitions Node to the server and update the local value if the operation succeeds.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>
    writeBitFieldsDefinitionsAsync(org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[] value)
    An asynchronous implementation of writeBitFieldsDefinitions(org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[]).

    Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.Node

    getAccessRestrictions, getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask

    Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.VariableNode

    getAccessLevel, getAccessLevelEx, getArrayDimensions, getDataType, getHistorizing, getMinimumSamplingInterval, getUserAccessLevel, getValue, getValueRank, setAccessLevel, setAccessLevelEx, setArrayDimensions, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValueRank

  • Field Details

    • BIT_FIELDS_DEFINITIONS

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[]> BIT_FIELDS_DEFINITIONS

  • Method Details

    • getBitFieldsDefinitions

      org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[] getBitFieldsDefinitions() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the BitFieldsDefinitions Node.

      The returned value is the last seen; it is not read live from the server.

      Returns:
      the local value of the BitFieldsDefinitions Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the BitFieldsDefinitions Node.

    • setBitFieldsDefinitions

      void setBitFieldsDefinitions(org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the BitFieldsDefinitions Node.

      The value is only updated locally; it is not written to the server.

      Parameters:
      value - the local value to set for the BitFieldsDefinitions Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the BitFieldsDefinitions Node.

    • readBitFieldsDefinitions

      org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[] readBitFieldsDefinitions() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the BitFieldsDefinitions Node from the server and update the local value if the operation succeeds.
      Returns:
      the BitFieldDefinition value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeBitFieldsDefinitions

      void writeBitFieldsDefinitions(org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the BitFieldsDefinitions Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the BitFieldDefinition value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readBitFieldsDefinitionsAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[]> readBitFieldsDefinitionsAsync()
      An asynchronous implementation of readBitFieldsDefinitions().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeBitFieldsDefinitionsAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeBitFieldsDefinitionsAsync(org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[] value)
      An asynchronous implementation of writeBitFieldsDefinitions(org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[]).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getBitFieldsDefinitionsNode

      PropertyType getBitFieldsDefinitionsNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the BitFieldsDefinitions PropertyType Node, or null if it does not exist.

      The Node is created when first accessed and cached for subsequent calls.

      Returns:
      the BitFieldsDefinitions PropertyType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getBitFieldsDefinitionsNodeAsync

      CompletableFuture<? extends PropertyType> getBitFieldsDefinitionsNodeAsync()
      Asynchronous implementation of getBitFieldsDefinitionsNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.