Package Arp.Services.DataLogger.Services.Grpc

Class IDataLoggerService2Grpc.IDataLoggerService2FutureStub

java.lang.Object
io.grpc.stub.AbstractStub<IDataLoggerService2Grpc.IDataLoggerService2FutureStub>
io.grpc.stub.AbstractFutureStub<IDataLoggerService2Grpc.IDataLoggerService2FutureStub>
Arp.Services.DataLogger.Services.Grpc.IDataLoggerService2Grpc.IDataLoggerService2FutureStub
Enclosing class:
IDataLoggerService2Grpc
public static final class IDataLoggerService2Grpc.IDataLoggerService2FutureStub extends io.grpc.stub.AbstractFutureStub<IDataLoggerService2Grpc.IDataLoggerService2FutureStub>

  • Constructor Details

    • IDataLoggerService2FutureStub

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

  • Method Details

    • build

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

    • listSessionNames

      public com.google.common.util.concurrent.ListenableFuture<IDataLoggerService2OuterClass.IDataLoggerService2ListSessionNamesResponse> listSessionNames(com.google.protobuf.Empty request)
      / <summary>
 / List all names of sessions inside the data logger component.
 / </summary>
 / <returns>Array of session names.</returns>

    • createSession

      public com.google.common.util.concurrent.ListenableFuture<IDataLoggerService2OuterClass.IDataLoggerService2CreateSessionResponse> createSession(IDataLoggerService2OuterClass.IDataLoggerService2CreateSessionRequest request)
      / <summary>
 / Tries to create a new session.
 / </summary>
 / <param name="sessionName">Name of session to be created.</param>
 / <param name="persistent">If set to <c>true</c>, the newly created session will not be removed when the RSC connection is closed.</param>
 / <returns>
 / <see cref="Arp.Device.Interface.Services.ErrorCode" /> for more information</returns>

    • removeSession

      public com.google.common.util.concurrent.ListenableFuture<IDataLoggerService2OuterClass.IDataLoggerService2RemoveSessionResponse> removeSession(IDataLoggerService2OuterClass.IDataLoggerService2RemoveSessionRequest request)
      / <summary>
 / Tries to remove a session.
 / </summary>
 / <param name="sessionName">Name of session to be removed.</param>
 / <returns>
 / <see cref="Arp.Device.Interface.Services.ErrorCode" /> for more information</returns>

    • startSession

      public com.google.common.util.concurrent.ListenableFuture<IDataLoggerService2OuterClass.IDataLoggerService2StartSessionResponse> startSession(IDataLoggerService2OuterClass.IDataLoggerService2StartSessionRequest request)
      / <summary>
 / Tries to start a logging session.
 / </summary>
 / <param name="sessionName">Name of session to be started.</param>
 / <returns>
 / <see cref="Arp.Device.Interface.Services.ErrorCode" /> for more information</returns>

    • stopSession

      public com.google.common.util.concurrent.ListenableFuture<IDataLoggerService2OuterClass.IDataLoggerService2StopSessionResponse> stopSession(IDataLoggerService2OuterClass.IDataLoggerService2StopSessionRequest request)
      / <summary>
 / Tries to stop a logging session.
 / </summary>
 / <param name="sessionName">Name of session to be stopped.</param>
 / <returns>
 / <see cref="Arp.Device.Interface.Services.ErrorCode" /> for more information</returns>

    • configureSession

      public com.google.common.util.concurrent.ListenableFuture<IDataLoggerService2OuterClass.IDataLoggerService2ConfigureSessionResponse> configureSession(IDataLoggerService2OuterClass.IDataLoggerService2ConfigureSessionRequest request)
      / <summary>
 / (Re)configures a session
 / </summary>
 / <param name="sessionname">Name of session to be created or reconfigured</param>
 / <param name="properties">Collection of attributes forming the configuration for the session</param>
 / <returns>
 / <cref name="ErrorCode" /> for more details</returns>

    • getSessionConfiguration

      public com.google.common.util.concurrent.ListenableFuture<IDataLoggerService2OuterClass.IDataLoggerService2GetSessionConfigurationResponse> getSessionConfiguration(IDataLoggerService2OuterClass.IDataLoggerService2GetSessionConfigurationRequest request)
      / <summary>
 / Tries to query the current configuration of a session
 / </summary>
 / <param name="sessionname">Name of session to be queried</param>
 / <param name="properties">Collection of attributes forming the sessions configuration after successfull invocation</param>
 / <param name="isPersistent">Determines if the session will remain (<c>true</c>) when the connection to the server is closed or not</param>
 / <returns>
 / <cref name="ErrorCode" /> for more details</returns>

    • getSessionState

      public com.google.common.util.concurrent.ListenableFuture<IDataLoggerService2OuterClass.IDataLoggerService2GetSessionStateResponse> getSessionState(IDataLoggerService2OuterClass.IDataLoggerService2GetSessionStateRequest request)
      / <summary>
 / Tries to query the state of a session.
 / </summary>
 / <param name="sessionName">Name of session to query state of.</param>
 / <param name="state">Container for state of session, if session exists. The value after return from call is
 / unspecified if the session does not exists.</param>
 / <returns>
 / <see cref="Arp.Device.Interface.Services.ErrorCode" /> for more information</returns>

    • setVariables

      public com.google.common.util.concurrent.ListenableFuture<IDataLoggerService2OuterClass.IDataLoggerService2SetVariablesResponse> setVariables(IDataLoggerService2OuterClass.IDataLoggerService2SetVariablesRequest request)
      / <summary>
 / Tries to add a variable to a session.
 / </summary>
 / <param name="sessionName">Name of session where variable should be added.</param>
 / <param name="variableNames">Name of variable to be added to session.</param>
 / <returns>
 / <see cref="Arp.Device.Interface.Services.ErrorCode" /> for more information</returns>

    • getLoggedVariables

      public com.google.common.util.concurrent.ListenableFuture<IDataLoggerService2OuterClass.IDataLoggerService2GetLoggedVariablesResponse> getLoggedVariables(IDataLoggerService2OuterClass.IDataLoggerService2GetLoggedVariablesRequest request)
      / <summary>
 / Queries all infos about logged variables of a session.
 / </summary>
 / <param name="sessionName">Name of session to query logged variables</param>
 / <param name="infos">Iterator which can be used to list logged variables after successful call</param>
 / <returns>
 / <see cref="Arp.Device.Interface.Services.ErrorCode" /> for more information</returns>

    • readVariablesData

      public com.google.common.util.concurrent.ListenableFuture<IDataLoggerService2OuterClass.IDataLoggerService2ReadVariablesDataResponse> readVariablesData(IDataLoggerService2OuterClass.IDataLoggerService2ReadVariablesDataRequest request)
      / <summary>
 / Read the data from the given variable from the session with the session name.
 / </summary>
 / <remarks>
 / <para>
 / This service function returns the plain data values from
 / the passed variable names including timestamps and data series consistent flags,
 / which is called a record.
 / In a record the values are in a static order and doesn't contain
 / any type information. Each record starts with the timestamp followed by
 / the values from the given variable by names and the consistent flag. The
 / record ends with a record type describing the cycle the record belongs to.
 / </para>
 / <para>
 / Example:
 / <code>
 / Read variables from task A: a1, a2
 / from task B: b1
 /
 / Results in:
 / object[]
 / timestamp task A, a1, a2, b1, consistent flag, record type
 / timestamp task B, a1, a2, b1, consistent flag, record type
 / </code></para>
 / <para>
 / The number of records depends on the given start and end time.
 / Each values will be returned between the start and end time.
 /
 / If the start time is zero, all available records until the end time
 / will be returned.
 /
 / If the end time is zero, all available records from the start time until
 / the last available record is reached will be returned.
 /
 / If the start and end time is zero, each available record will be returned.
 /
 / If the start time is greater than the end time, the resulted values are returned
 / in descending order.
 / </para>
 / </remarks>
 / <param name="sessionName">Name of session where variable should be read from.</param>
 / <param name="startTime">Start time to be read data.</param>
 / <param name="endTime">End time to be read data.</param>
 / <param name="variableNames">Name of variables to be read data.</param>
 / <param name="values">An enumerator which stores the read values.</param>
 / <returns>Returns <see cref="Arp.Device.Interface.Services.ErrorCode.None" /> on success.</returns>

    • getRotatedFileNames

      public com.google.common.util.concurrent.ListenableFuture<IDataLoggerService2OuterClass.IDataLoggerService2GetRotatedFileNamesResponse> getRotatedFileNames(IDataLoggerService2OuterClass.IDataLoggerService2GetRotatedFileNamesRequest request)
      / <summary>
 / Returns names of all files that have been written by a session
 / </summary>
 / <param name="sessionname">Name of session from which rotated files should be listed</param>
 / <param name="filenames">Iterator to list names of all rotated files on successful call.</param>
 / <returns>
 / ErrorCode.NoData in case the session has no data sink configured.
 / </returns>

    • getSessionNames

      public com.google.common.util.concurrent.ListenableFuture<IDataLoggerService2OuterClass.IDataLoggerService2GetSessionNamesResponse> getSessionNames(IDataLoggerService2OuterClass.IDataLoggerService2GetSessionNamesRequest request)
      / <summary>
 / Tries to retrieve names of sessions which log assigned variables
 / </summary>
 / <param name="variablename">Name of variable to which corresponding sessions should be found</param>
 / <returns>Enumeration of names of sessions which log the variable in question</returns>

    • setTriggerCondition

      public com.google.common.util.concurrent.ListenableFuture<IDataLoggerService2OuterClass.IDataLoggerService2SetTriggerConditionResponse> setTriggerCondition(IDataLoggerService2OuterClass.IDataLoggerService2SetTriggerConditionRequest request)
      / <summary>
 / Sets a trigger condition
 / </summary>
 / <remarks>
 / Configuration of the trigger is done in RPN (Reverse Polish Notation). Each operand or operation is a single <see cref="Arp.Device.Interface.Services.TriggerRpnItem" />. Only
 / if the condition specified by the trigger is fullfilled values are logged and stored inside the sink.
 /
 / The amount of cycles that should be stored before the condition was fullfilled can be configured using <c>preCycleCount</c> whereas the amount of
 / cycles that should be recorded afterwards can be configured using <c>postCycleCount</c>. If <c>postCycleCount</c> is set to 0 then the
 / recording continues until IDataLoggerService::StopSession is called or the PLC project is stopped.
 / </remarks>
 / <param name="sessionName">Name of session to set trigger condition</param>
 / <param name="taskName">Name of task where trigger condition is evaluated</param>
 / <param name="preCycleCount">Amount of datasets recorded before the condition was triggered</param>
 / <param name="postCycleCount">Amount of dataset recorded ater the condition is triggered (0 means endless)</param>
 / <param name="triggerCondition">List of trigger items. All items are evaluated in order of their position inside the list.</param>
 / <returns>
 / <see cref="Arp.Device.Interface.Services.ErrorCode" /> for more information</returns>