Package org.yamcs.protobuf

Class ParameterSubscriptionRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, ParameterSubscriptionRequestOrBuilder
    public final class ParameterSubscriptionRequest
extends com.google.protobuf.GeneratedMessageV3
implements ParameterSubscriptionRequestOrBuilder
     Used for parameter subscription and unsubscription.
    Protobuf type yamcs.protobuf.web.ParameterSubscriptionRequest
    See Also:
    Serialized Form

    • Method Detail

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasAbortOnInvalid

        public boolean hasAbortOnInvalid()
        if set to true, an error message will be sent back if any parameter from the list above is invalid
 by default is false
        optional bool abortOnInvalid = 2;
        Specified by:
        hasAbortOnInvalid in interface ParameterSubscriptionRequestOrBuilder

      • getAbortOnInvalid

        public boolean getAbortOnInvalid()
        if set to true, an error message will be sent back if any parameter from the list above is invalid
 by default is false
        optional bool abortOnInvalid = 2;
        Specified by:
        getAbortOnInvalid in interface ParameterSubscriptionRequestOrBuilder

      • hasUpdateOnExpiration

        public boolean hasUpdateOnExpiration()
         if set to true, send parameter updates when parameters expire.
 the parameter will have the same value and timestamp like the previous sent one, but the acquisition status will be set to EXPIRED (instead of ACQUIRED)
by default is false
        optional bool updateOnExpiration = 3;
        Specified by:
        hasUpdateOnExpiration in interface ParameterSubscriptionRequestOrBuilder

      • getUpdateOnExpiration

        public boolean getUpdateOnExpiration()
         if set to true, send parameter updates when parameters expire.
 the parameter will have the same value and timestamp like the previous sent one, but the acquisition status will be set to EXPIRED (instead of ACQUIRED)
by default is false
        optional bool updateOnExpiration = 3;
        Specified by:
        getUpdateOnExpiration in interface ParameterSubscriptionRequestOrBuilder

      • hasSendFromCache

        public boolean hasSendFromCache()
        if set to true (default), send a first batch of the parameters from cache if available
 otherwise just wait for the parameters to be updated
        optional bool sendFromCache = 4;
        Specified by:
        hasSendFromCache in interface ParameterSubscriptionRequestOrBuilder

      • getSendFromCache

        public boolean getSendFromCache()
        if set to true (default), send a first batch of the parameters from cache if available
 otherwise just wait for the parameters to be updated
        optional bool sendFromCache = 4;
        Specified by:
        getSendFromCache in interface ParameterSubscriptionRequestOrBuilder

      • hasSubscriptionId

        public boolean hasSubscriptionId()
        subcriptionId
  0 or not specified means to add parameters to the first subscription made
     this is for compatibility with the previous yamcs version before 4.1 
     when it was not possible to have multiple subscriptions   
 -1 means to create a new subscription
 >1 means to add parameters to the existing subcription with that id
        optional int32 subscriptionId = 5;
        Specified by:
        hasSubscriptionId in interface ParameterSubscriptionRequestOrBuilder

      • getSubscriptionId

        public int getSubscriptionId()
        subcriptionId
  0 or not specified means to add parameters to the first subscription made
     this is for compatibility with the previous yamcs version before 4.1 
     when it was not possible to have multiple subscriptions   
 -1 means to create a new subscription
 >1 means to add parameters to the existing subcription with that id
        optional int32 subscriptionId = 5;
        Specified by:
        getSubscriptionId in interface ParameterSubscriptionRequestOrBuilder

      • hasUseNumericIds

        public boolean hasUseNumericIds()
        if set to true (higly recommended), a uint32 numeric id will be assigned to each parameter and will be sent back together with the value (instead of the NamedObjectId)
 this is done in order to reduce the bandwith used for transfering the parameter identifiers (since the NamedObjectId are quite long)
 Note that the numeric id is only unique on the websocket connection
 the ParameterSubscriptionResponse will contain the mapping id to NamedObjectId
        optional bool useNumericIds = 6;
        Specified by:
        hasUseNumericIds in interface ParameterSubscriptionRequestOrBuilder

      • getUseNumericIds

        public boolean getUseNumericIds()
        if set to true (higly recommended), a uint32 numeric id will be assigned to each parameter and will be sent back together with the value (instead of the NamedObjectId)
 this is done in order to reduce the bandwith used for transfering the parameter identifiers (since the NamedObjectId are quite long)
 Note that the numeric id is only unique on the websocket connection
 the ParameterSubscriptionResponse will contain the mapping id to NamedObjectId
        optional bool useNumericIds = 6;
        Specified by:
        getUseNumericIds in interface ParameterSubscriptionRequestOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ParameterSubscriptionRequest parseFrom​(ByteBuffer data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ParameterSubscriptionRequest parseFrom​(ByteBuffer data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ParameterSubscriptionRequest parseFrom​(com.google.protobuf.ByteString data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ParameterSubscriptionRequest parseFrom​(com.google.protobuf.ByteString data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ParameterSubscriptionRequest parseFrom​(byte[] data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ParameterSubscriptionRequest parseFrom​(byte[] data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public ParameterSubscriptionRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ParameterSubscriptionRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ParameterSubscriptionRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ParameterSubscriptionRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ParameterSubscriptionRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder