org.yamcs.protobuf

Interface ParameterSubscriptionRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ParameterSubscriptionRequest, ParameterSubscriptionRequest.Builder

public interface ParameterSubscriptionRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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;
Yamcs.NamedObjectId	getId(int index) repeated .yamcs.protobuf.NamedObjectId id = 1;
int	getIdCount() repeated .yamcs.protobuf.NamedObjectId id = 1;
List<Yamcs.NamedObjectId>	getIdList() repeated .yamcs.protobuf.NamedObjectId id = 1;
Yamcs.NamedObjectIdOrBuilder	getIdOrBuilder(int index) repeated .yamcs.protobuf.NamedObjectId id = 1;
List<? extends Yamcs.NamedObjectIdOrBuilder>	getIdOrBuilderList() repeated .yamcs.protobuf.NamedObjectId id = 1;
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;
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;
boolean	getUpdateOnExpiration() if set to true, send parameter updates when parameters expire.
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;
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;
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;
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;
boolean	hasUpdateOnExpiration() if set to true, send parameter updates when parameters expire.
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;

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getIdList

List<Yamcs.NamedObjectId> getIdList()

repeated .yamcs.protobuf.NamedObjectId id = 1;

getId

Yamcs.NamedObjectId getId(int index)

repeated .yamcs.protobuf.NamedObjectId id = 1;

getIdCount

int getIdCount()

repeated .yamcs.protobuf.NamedObjectId id = 1;

getIdOrBuilderList

List<? extends Yamcs.NamedObjectIdOrBuilder> getIdOrBuilderList()

repeated .yamcs.protobuf.NamedObjectId id = 1;

getIdOrBuilder

Yamcs.NamedObjectIdOrBuilder getIdOrBuilder(int index)

repeated .yamcs.protobuf.NamedObjectId id = 1;

hasAbortOnInvalid

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;

getAbortOnInvalid

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;

hasUpdateOnExpiration

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;

getUpdateOnExpiration

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;

hasSendFromCache

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;

getSendFromCache

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;

hasSubscriptionId

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;

getSubscriptionId

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;

hasUseNumericIds

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;

getUseNumericIds

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;