Package org.yamcs.protobuf

Interface TemplateVariableOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    TemplateVariable, TemplateVariable.Builder
    public interface TemplateVariableOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getChoices​(int index)
      List of valid choices
      com.google.protobuf.ByteString getChoicesBytes​(int index)
      List of valid choices
      int getChoicesCount()
      List of valid choices
      List<String> getChoicesList()
      List of valid choices
      String getHelp()
      Verbose user guidance (HTML)
      com.google.protobuf.ByteString getHelpBytes()
      Verbose user guidance (HTML)
      String getInitial()
      Initial value for use in UI forms
      com.google.protobuf.ByteString getInitialBytes()
      Initial value for use in UI forms
      String getLabel()
      Verbose name for use in UI forms
      com.google.protobuf.ByteString getLabelBytes()
      Verbose name for use in UI forms
      String getName()
      Variable name.
      com.google.protobuf.ByteString getNameBytes()
      Variable name.
      boolean getRequired()
      Whether this variable is required input
      String getType()
      Type of variable (Java class extending org.yamcs.templating.Variable)
      com.google.protobuf.ByteString getTypeBytes()
      Type of variable (Java class extending org.yamcs.templating.Variable)
      boolean hasHelp()
      Verbose user guidance (HTML)
      boolean hasInitial()
      Initial value for use in UI forms
      boolean hasLabel()
      Verbose name for use in UI forms
      boolean hasName()
      Variable name.
      boolean hasRequired()
      Whether this variable is required input
      boolean hasType()
      Type of variable (Java class extending org.yamcs.templating.Variable)

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • hasName

        boolean hasName()
         Variable name.
        optional string name = 1;
        Returns:
        Whether the name field is set.

      • getName

        String getName()
         Variable name.
        optional string name = 1;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Variable name.
        optional string name = 1;
        Returns:
        The bytes for name.

      • hasLabel

        boolean hasLabel()
         Verbose name for use in UI forms
        optional string label = 6;
        Returns:
        Whether the label field is set.

      • getLabel

        String getLabel()
         Verbose name for use in UI forms
        optional string label = 6;
        Returns:
        The label.

      • getLabelBytes

        com.google.protobuf.ByteString getLabelBytes()
         Verbose name for use in UI forms
        optional string label = 6;
        Returns:
        The bytes for label.

      • hasType

        boolean hasType()
         Type of variable (Java class extending org.yamcs.templating.Variable)
        optional string type = 4;
        Returns:
        Whether the type field is set.

      • getType

        String getType()
         Type of variable (Java class extending org.yamcs.templating.Variable)
        optional string type = 4;
        Returns:
        The type.

      • getTypeBytes

        com.google.protobuf.ByteString getTypeBytes()
         Type of variable (Java class extending org.yamcs.templating.Variable)
        optional string type = 4;
        Returns:
        The bytes for type.

      • hasHelp

        boolean hasHelp()
         Verbose user guidance (HTML)
        optional string help = 2;
        Returns:
        Whether the help field is set.

      • getHelp

        String getHelp()
         Verbose user guidance (HTML)
        optional string help = 2;
        Returns:
        The help.

      • getHelpBytes

        com.google.protobuf.ByteString getHelpBytes()
         Verbose user guidance (HTML)
        optional string help = 2;
        Returns:
        The bytes for help.

      • hasRequired

        boolean hasRequired()
         Whether this variable is required input
        optional bool required = 3;
        Returns:
        Whether the required field is set.

      • getRequired

        boolean getRequired()
         Whether this variable is required input
        optional bool required = 3;
        Returns:
        The required.

      • getChoicesList

        List<String> getChoicesList()
         List of valid choices
        repeated string choices = 5;
        Returns:
        A list containing the choices.

      • getChoicesCount

        int getChoicesCount()
         List of valid choices
        repeated string choices = 5;
        Returns:
        The count of choices.

      • getChoices

        String getChoices​(int index)
         List of valid choices
        repeated string choices = 5;
        Parameters:
        index - The index of the element to return.
        Returns:
        The choices at the given index.

      • getChoicesBytes

        com.google.protobuf.ByteString getChoicesBytes​(int index)
         List of valid choices
        repeated string choices = 5;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the choices at the given index.

      • hasInitial

        boolean hasInitial()
         Initial value for use in UI forms
        optional string initial = 7;
        Returns:
        Whether the initial field is set.

      • getInitial

        String getInitial()
         Initial value for use in UI forms
        optional string initial = 7;
        Returns:
        The initial.

      • getInitialBytes

        com.google.protobuf.ByteString getInitialBytes()
         Initial value for use in UI forms
        optional string initial = 7;
        Returns:
        The bytes for initial.