Package com.viam.service.motion.v1

Class Motion.Plan

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<Motion.Plan,Motion.Plan.Builder>
com.viam.service.motion.v1.Motion.Plan
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, Motion.PlanOrBuilder
Enclosing class:
Motion
public static final class Motion.Plan extends com.google.protobuf.GeneratedMessageLite<Motion.Plan,Motion.Plan.Builder> implements Motion.PlanOrBuilder
 A plan describes a motion plan
Protobuf type viam.service.motion.v1.Plan

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Motion.Plan.Builder
    A plan describes a motion plan

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type extends Object>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    COMPONENT_NAME_DEPRECATED_FIELD_NUMBER
     
    static final int
    COMPONENT_NAME_FIELD_NUMBER
     
    static final int
    EXECUTION_ID_FIELD_NUMBER
     
    static final int
    ID_FIELD_NUMBER
     
    static final int
    STEPS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    String
    getComponentName()
    The component requested to be moved.
    com.google.protobuf.ByteString
    getComponentNameBytes()
    The component requested to be moved.
    Common.ResourceName
    getComponentNameDeprecated()
    Deprecated.
    static Motion.Plan
    getDefaultInstance()
     
    String
    getExecutionId()
    The unique ID which identifies the execution.
    com.google.protobuf.ByteString
    getExecutionIdBytes()
    The unique ID which identifies the execution.
    String
    getId()
    The plan's unique ID
    com.google.protobuf.ByteString
    getIdBytes()
    The plan's unique ID
    Motion.PlanStep
    getSteps(int index)
    The steps of a plan is an ordered list of plan steps
    int
    getStepsCount()
    The steps of a plan is an ordered list of plan steps
    List<Motion.PlanStep>
    getStepsList()
    The steps of a plan is an ordered list of plan steps
    Motion.PlanStepOrBuilder
    getStepsOrBuilder(int index)
    The steps of a plan is an ordered list of plan steps
    List<? extends Motion.PlanStepOrBuilder>
    getStepsOrBuilderList()
    The steps of a plan is an ordered list of plan steps
    boolean
    hasComponentNameDeprecated()
    Deprecated.
    static Motion.Plan.Builder
    newBuilder()
     
    static Motion.Plan.Builder
    newBuilder(Motion.Plan prototype)
     
    static Motion.Plan
    parseDelimitedFrom(InputStream input)
     
    static Motion.Plan
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Motion.Plan
    parseFrom(byte[] data)
     
    static Motion.Plan
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Motion.Plan
    parseFrom(com.google.protobuf.ByteString data)
     
    static Motion.Plan
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Motion.Plan
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Motion.Plan
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Motion.Plan
    parseFrom(InputStream input)
     
    static Motion.Plan
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Motion.Plan
    parseFrom(ByteBuffer data)
     
    static Motion.Plan
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Motion.Plan>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

    • ID_FIELD_NUMBER

      public static final int ID_FIELD_NUMBER
      See Also:

    • COMPONENT_NAME_DEPRECATED_FIELD_NUMBER

      public static final int COMPONENT_NAME_DEPRECATED_FIELD_NUMBER
      See Also:

    • EXECUTION_ID_FIELD_NUMBER

      public static final int EXECUTION_ID_FIELD_NUMBER
      See Also:

    • STEPS_FIELD_NUMBER

      public static final int STEPS_FIELD_NUMBER
      See Also:

    • COMPONENT_NAME_FIELD_NUMBER

      public static final int COMPONENT_NAME_FIELD_NUMBER
      See Also:

  • Method Details

    • getId

      public String getId()
       The plan's unique ID
      string id = 1 [json_name = "id"];
      Specified by:
      getId in interface Motion.PlanOrBuilder
      Returns:
      The id.

    • getIdBytes

      public com.google.protobuf.ByteString getIdBytes()
       The plan's unique ID
      string id = 1 [json_name = "id"];
      Specified by:
      getIdBytes in interface Motion.PlanOrBuilder
      Returns:
      The bytes for id.

    • hasComponentNameDeprecated

      @Deprecated public boolean hasComponentNameDeprecated()
      Deprecated.
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 2 [json_name = "componentNameDeprecated", deprecated = true];
      Specified by:
      hasComponentNameDeprecated in interface Motion.PlanOrBuilder
      Returns:
      Whether the componentNameDeprecated field is set.

    • getComponentNameDeprecated

      @Deprecated public Common.ResourceName getComponentNameDeprecated()
      Deprecated.
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 2 [json_name = "componentNameDeprecated", deprecated = true];
      Specified by:
      getComponentNameDeprecated in interface Motion.PlanOrBuilder
      Returns:
      The componentNameDeprecated.

    • getExecutionId

      public String getExecutionId()
       The unique ID which identifies the execution.
 Multiple plans will share the same execution_id if they were
 generated due to replanning
      string execution_id = 3 [json_name = "executionId"];
      Specified by:
      getExecutionId in interface Motion.PlanOrBuilder
      Returns:
      The executionId.

    • getExecutionIdBytes

      public com.google.protobuf.ByteString getExecutionIdBytes()
       The unique ID which identifies the execution.
 Multiple plans will share the same execution_id if they were
 generated due to replanning
      string execution_id = 3 [json_name = "executionId"];
      Specified by:
      getExecutionIdBytes in interface Motion.PlanOrBuilder
      Returns:
      The bytes for executionId.

    • getStepsList

      public List<Motion.PlanStep> getStepsList()
       The steps of a plan is an ordered list of plan steps
      repeated .viam.service.motion.v1.PlanStep steps = 4 [json_name = "steps"];
      Specified by:
      getStepsList in interface Motion.PlanOrBuilder

    • getStepsOrBuilderList

      public List<? extends Motion.PlanStepOrBuilder> getStepsOrBuilderList()
       The steps of a plan is an ordered list of plan steps
      repeated .viam.service.motion.v1.PlanStep steps = 4 [json_name = "steps"];

    • getStepsCount

      public int getStepsCount()
       The steps of a plan is an ordered list of plan steps
      repeated .viam.service.motion.v1.PlanStep steps = 4 [json_name = "steps"];
      Specified by:
      getStepsCount in interface Motion.PlanOrBuilder

    • getSteps

      public Motion.PlanStep getSteps(int index)
       The steps of a plan is an ordered list of plan steps
      repeated .viam.service.motion.v1.PlanStep steps = 4 [json_name = "steps"];
      Specified by:
      getSteps in interface Motion.PlanOrBuilder

    • getStepsOrBuilder

      public Motion.PlanStepOrBuilder getStepsOrBuilder(int index)
       The steps of a plan is an ordered list of plan steps
      repeated .viam.service.motion.v1.PlanStep steps = 4 [json_name = "steps"];

    • getComponentName

      public String getComponentName()
       The component requested to be moved.
 Used for tracking & stopping.
 NOTE: A plan may move more components than just the
 root component.
      string component_name = 5 [json_name = "componentName"];
      Specified by:
      getComponentName in interface Motion.PlanOrBuilder
      Returns:
      The componentName.

    • getComponentNameBytes

      public com.google.protobuf.ByteString getComponentNameBytes()
       The component requested to be moved.
 Used for tracking & stopping.
 NOTE: A plan may move more components than just the
 root component.
      string component_name = 5 [json_name = "componentName"];
      Specified by:
      getComponentNameBytes in interface Motion.PlanOrBuilder
      Returns:
      The bytes for componentName.

    • parseFrom

      public static Motion.Plan parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Motion.Plan parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Motion.Plan parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Motion.Plan parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Motion.Plan parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Motion.Plan parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Motion.Plan parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Motion.Plan parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static Motion.Plan.Builder newBuilder()

    • newBuilder

      public static Motion.Plan.Builder newBuilder(Motion.Plan prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<Motion.Plan,Motion.Plan.Builder>

    • getDefaultInstance

      public static Motion.Plan getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Motion.Plan> parser()