org.yamcs.protobuf.Cop1StatusOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
There is a newer version: 5.10.9
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: yamcs/protobuf/cop1/cop1.proto

package org.yamcs.protobuf;

public interface Cop1StatusOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.cop1.Cop1Status)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Link name for which this status applies. 
   * It is present when this message is sent over the websocket as there might
   * be multiple COP-1 links subscribed
   * 
   *
   * optional string link = 11;
   * @return Whether the link field is set.
   */
  boolean hasLink();
  /**
   *    * Link name for which this status applies. 
   * It is present when this message is sent over the websocket as there might
   * be multiple COP-1 links subscribed
   * 
   *
   * optional string link = 11;
   * @return The link.
   */
  java.lang.String getLink();
  /**
   *    * Link name for which this status applies. 
   * It is present when this message is sent over the websocket as there might
   * be multiple COP-1 links subscribed
   * 
   *
   * optional string link = 11;
   * @return The bytes for link.
   */
  com.google.protobuf.ByteString
      getLinkBytes();

  /**
   *    * If false, all frames are immediately transmitted (i.e. COP-1 is disabled)
   * 
   *
   * optional bool cop1Active = 1;
   * @return Whether the cop1Active field is set.
   */
  boolean hasCop1Active();
  /**
   *    * If false, all frames are immediately transmitted (i.e. COP-1 is disabled)
   * 
   *
   * optional bool cop1Active = 1;
   * @return The cop1Active.
   */
  boolean getCop1Active();

  /**
   *    * Relevant if cop1Active = false -> set the bypass flag on all outgoing frames 
   * 
   *
   * optional bool setBypassAll = 2;
   * @return Whether the setBypassAll field is set.
   */
  boolean hasSetBypassAll();
  /**
   *    * Relevant if cop1Active = false -> set the bypass flag on all outgoing frames 
   * 
   *
   * optional bool setBypassAll = 2;
   * @return The setBypassAll.
   */
  boolean getSetBypassAll();

  /**
   *    * Last received CLCW
   * 
   *
   * optional .yamcs.protobuf.cop1.Clcw clcw = 3;
   * @return Whether the clcw field is set.
   */
  boolean hasClcw();
  /**
   *    * Last received CLCW
   * 
   *
   * optional .yamcs.protobuf.cop1.Clcw clcw = 3;
   * @return The clcw.
   */
  org.yamcs.protobuf.Clcw getClcw();
  /**
   *    * Last received CLCW
   * 
   *
   * optional .yamcs.protobuf.cop1.Clcw clcw = 3;
   */
  org.yamcs.protobuf.ClcwOrBuilder getClcwOrBuilder();

  /**
   *    * Current state of FOP-1 state machine, only relevant if cop1Active = true
   * 
   *
   * optional .yamcs.protobuf.cop1.Cop1State state = 4;
   * @return Whether the state field is set.
   */
  boolean hasState();
  /**
   *    * Current state of FOP-1 state machine, only relevant if cop1Active = true
   * 
   *
   * optional .yamcs.protobuf.cop1.Cop1State state = 4;
   * @return The state.
   */
  org.yamcs.protobuf.Cop1State getState();

  /**
   *    * V(S) - Transmitter Frame Sequence Number;
   * 
   *
   * optional uint32 vS = 5;
   * @return Whether the vS field is set.
   */
  boolean hasVS();
  /**
   *    * V(S) - Transmitter Frame Sequence Number;
   * 
   *
   * optional uint32 vS = 5;
   * @return The vS.
   */
  int getVS();

  /**
   *    * The nR from the previous CLCW
   * 
   *
   * optional uint32 nnR = 6;
   * @return Whether the nnR field is set.
   */
  boolean hasNnR();
  /**
   *    * The nR from the previous CLCW
   * 
   *
   * optional uint32 nnR = 6;
   * @return The nnR.
   */
  int getNnR();

  /**
   *    * Number of TC packets in the wait queue
   * 
   *
   * optional uint32 waitQueueNumTC = 7;
   * @return Whether the waitQueueNumTC field is set.
   */
  boolean hasWaitQueueNumTC();
  /**
   *    * Number of TC packets in the wait queue
   * 
   *
   * optional uint32 waitQueueNumTC = 7;
   * @return The waitQueueNumTC.
   */
  int getWaitQueueNumTC();

  /**
   *    * Number of unacknowledged frames in the sent queue
   * 
   *
   * optional uint32 sentQueueNumFrames = 8;
   * @return Whether the sentQueueNumFrames field is set.
   */
  boolean hasSentQueueNumFrames();
  /**
   *    * Number of unacknowledged frames in the sent queue
   * 
   *
   * optional uint32 sentQueueNumFrames = 8;
   * @return The sentQueueNumFrames.
   */
  int getSentQueueNumFrames();

  /**
   *    * Number of frames in the out queue (waiting to be picked up by the master chain
   * multiplexer)
   * 
   *
   * optional uint32 outQueueNumFrames = 9;
   * @return Whether the outQueueNumFrames field is set.
   */
  boolean hasOutQueueNumFrames();
  /**
   *    * Number of frames in the out queue (waiting to be picked up by the master chain
   * multiplexer)
   * 
   *
   * optional uint32 outQueueNumFrames = 9;
   * @return The outQueueNumFrames.
   */
  int getOutQueueNumFrames();

  /**
   *    * How many times the last frame has been transmitted
   * 
   *
   * optional uint32 txCount = 10;
   * @return Whether the txCount field is set.
   */
  boolean hasTxCount();
  /**
   *    * How many times the last frame has been transmitted
   * 
   *
   * optional uint32 txCount = 10;
   * @return The txCount.
   */
  int getTxCount();
}