Package Arp.Plc.Gds.Services.Grpc

Class IForceServiceGrpc.IForceServiceFutureStub

java.lang.Object
io.grpc.stub.AbstractStub<IForceServiceGrpc.IForceServiceFutureStub>
io.grpc.stub.AbstractFutureStub<IForceServiceGrpc.IForceServiceFutureStub>
Arp.Plc.Gds.Services.Grpc.IForceServiceGrpc.IForceServiceFutureStub
Enclosing class:
IForceServiceGrpc
public static final class IForceServiceGrpc.IForceServiceFutureStub extends io.grpc.stub.AbstractFutureStub<IForceServiceGrpc.IForceServiceFutureStub>

  • Constructor Details

    • IForceServiceFutureStub

      private IForceServiceFutureStub(io.grpc.Channel channel, io.grpc.CallOptions callOptions)

  • Method Details

    • build

      protected IForceServiceGrpc.IForceServiceFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<IForceServiceGrpc.IForceServiceFutureStub>

    • addVariable

      public com.google.common.util.concurrent.ListenableFuture<IForceServiceOuterClass.IForceServiceAddVariableResponse> addVariable(IForceServiceOuterClass.IForceServiceAddVariableRequest request)
      / <summary>
 / Adds a new variable and value for forcing. Enables force mode.
 / </summary>
 / <remarks>
 / The enabled force mode is signalized by notification and by the
 / activated 'PlcState.Forcing'
 / </remarks>
 / <param name="item">
 / Force item <see cref="Arp.System.Commons.Services.Io.ForceItem" />, which contains the the name
 / of the variable with the full instance path and the force value.
 / The data type of the force value must be equal with the data type
 / of the target variable.
 / </param>
 / <returns>
 / Returns <see cref="Arp.System.Commons.Services.Io.DataAccessError.None" /> on success.
 / </returns>

    • removeVariable

      public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> removeVariable(IForceServiceOuterClass.IForceServiceRemoveVariableRequest request)
      / <summary>
 / Resets forced variable. Disables force mode after force list is empty.
 / </summary>
 / <param name="variableName">
 / Instance path of the variable.
 / </param>

    • getVariables

      public com.google.common.util.concurrent.ListenableFuture<IForceServiceOuterClass.IForceServiceGetVariablesResponse> getVariables(com.google.protobuf.Empty request)
      / <summary>
 / Gets a list of all forced variables.
 / </summary>
 / <returns>
 / Returns a list with all existing <see cref="Arp.System.Commons.Services.Io.ForceItem" /> objects.
 / </returns>

    • reset

      public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> reset(com.google.protobuf.Empty request)
      / <summary>
 / Resets the force list. Disables force mode.
 / </summary>
 / <remarks>
 / The disabled force mode is signalized by notification and by the
 / deactivated PlcState.
 / </remarks>

    • isForcable

      public com.google.common.util.concurrent.ListenableFuture<IForceServiceOuterClass.IForceServiceIsForcableResponse> isForcable(IForceServiceOuterClass.IForceServiceIsForcableRequest request)
      / <summary>
 / Tests whether variable is forcable.
 / </summary>
 / <remarks>
 / The variable has to meet the following requirements to be forcable:
 / 1. The kind of variable should be an In- or an Out-port of a program
 / (IEC, C ++, Simulink ...) or a variable that is connected to I/O data.
 / 2. The data type of the variable has to be supported.
 / </remarks>
 / <returns>
 / <b>true</b>if the variable is forcable.</returns>

    • isActive

      public com.google.common.util.concurrent.ListenableFuture<IForceServiceOuterClass.IForceServiceIsActiveResponse> isActive(com.google.protobuf.Empty request)
      / <summary>
 / Tests whether force mode is active.
 / </summary>
 / <returns>
 / <b>true</b>if the force mode is active.</returns>