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

Interface AlarmRateVariableType

All Superinterfaces:
BaseDataVariableType, BaseVariableType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode
All Known Implementing Classes:
AlarmRateVariableTypeNode
public interface AlarmRateVariableType 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.builtin.unsigned.UShort>
    RATE
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort
    getRate()
    Get the local value of the Rate Node.
    PropertyType
    getRateNode()
    Get the Rate PropertyType Node, or null if it does not exist.
    CompletableFuture<? extends PropertyType>
    getRateNodeAsync()
    Asynchronous implementation of getRateNode().
    org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort
    readRate()
    Read the value of the Rate Node from the server and update the local value if the operation succeeds.
    CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort>
    readRateAsync()
    An asynchronous implementation of readRate().
    void
    setRate(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)
    Set the local value of the Rate Node.
    void
    writeRate(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)
    Write a new value for the Rate Node to the server and update the local value if the operation succeeds.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>
    writeRateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)
    An asynchronous implementation of writeRate(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort).

    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

    • RATE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort> RATE

  • Method Details

    • getRate

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort getRate() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Rate Node.

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

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

    • setRate

      void setRate(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Rate Node.

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

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

    • readRate

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort readRate() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the Rate Node from the server and update the local value if the operation succeeds.
      Returns:
      the UShort value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeRate

      void writeRate(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the Rate Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the UShort value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readRateAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort> readRateAsync()
      An asynchronous implementation of readRate().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeRateAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeRateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)
      An asynchronous implementation of writeRate(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getRateNode

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

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

      Returns:
      the Rate 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.

    • getRateNodeAsync

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