Module org.yamcs.core
Package org.yamcs.parameter

Record Class ParameterRetrievalOptions

java.lang.Object
java.lang.Record
org.yamcs.parameter.ParameterRetrievalOptions
public record ParameterRetrievalOptions(long start, long stop, boolean ascending, boolean retrieveEngValues, boolean retrieveRawValues, boolean retrieveParameterStatus, boolean norealtime, boolean noparchive, boolean noreplay, org.yamcs.protobuf.Yamcs.PacketReplayRequest packetReplayRequest) extends Record
Contains retrieval options used when retrieving parameters.

  • Constructor Details

    • ParameterRetrievalOptions

      public ParameterRetrievalOptions(long start, long stop, boolean ascending, boolean retrieveEngValues, boolean retrieveRawValues, boolean retrieveParameterStatus, boolean norealtime, boolean noparchive, boolean noreplay, org.yamcs.protobuf.Yamcs.PacketReplayRequest packetReplayRequest)
      Creates an instance of a ParameterRetrievalOptions record class.
      Parameters:
      start - the value for the start record component
      stop - the value for the stop record component
      ascending - the value for the ascending record component
      retrieveEngValues - the value for the retrieveEngValues record component
      retrieveRawValues - the value for the retrieveRawValues record component
      retrieveParameterStatus - the value for the retrieveParameterStatus record component
      norealtime - the value for the norealtime record component
      noparchive - the value for the noparchive record component
      noreplay - the value for the noreplay record component
      packetReplayRequest - the value for the packetReplayRequest record component

  • Method Details

    • toBuilder

      public ParameterRetrievalOptions.Builder toBuilder()

    • withUpdatedStart

      public ParameterRetrievalOptions withUpdatedStart(long newStart)

    • withUpdatedStop

      public ParameterRetrievalOptions withUpdatedStop(long newStop)

    • newBuilder

      public static ParameterRetrievalOptions.Builder newBuilder()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • start

      public long start()
      Returns the value of the start record component.
      Returns:
      the value of the start record component

    • stop

      public long stop()
      Returns the value of the stop record component.
      Returns:
      the value of the stop record component

    • ascending

      public boolean ascending()
      Returns the value of the ascending record component.
      Returns:
      the value of the ascending record component

    • retrieveEngValues

      public boolean retrieveEngValues()
      Returns the value of the retrieveEngValues record component.
      Returns:
      the value of the retrieveEngValues record component

    • retrieveRawValues

      public boolean retrieveRawValues()
      Returns the value of the retrieveRawValues record component.
      Returns:
      the value of the retrieveRawValues record component

    • retrieveParameterStatus

      public boolean retrieveParameterStatus()
      Returns the value of the retrieveParameterStatus record component.
      Returns:
      the value of the retrieveParameterStatus record component

    • norealtime

      public boolean norealtime()
      Returns the value of the norealtime record component.
      Returns:
      the value of the norealtime record component

    • noparchive

      public boolean noparchive()
      Returns the value of the noparchive record component.
      Returns:
      the value of the noparchive record component

    • noreplay

      public boolean noreplay()
      Returns the value of the noreplay record component.
      Returns:
      the value of the noreplay record component

    • packetReplayRequest

      public org.yamcs.protobuf.Yamcs.PacketReplayRequest packetReplayRequest()
      Returns the value of the packetReplayRequest record component.
      Returns:
      the value of the packetReplayRequest record component