Package com.viam.service.motion.v1

Interface Motion.PlanOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
Motion.Plan, Motion.Plan.Builder
Enclosing class:
Motion
public static interface Motion.PlanOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Details

    • getId

      String getId()
       The plan's unique ID
      string id = 1 [json_name = "id"];
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       The plan's unique ID
      string id = 1 [json_name = "id"];
      Returns:
      The bytes for id.

    • hasComponentNameDeprecated

      @Deprecated boolean hasComponentNameDeprecated()
      Deprecated.
      viam.service.motion.v1.Plan.component_name_deprecated is deprecated. See service/motion/v1/motion.proto;l=379
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 2 [json_name = "componentNameDeprecated", deprecated = true];
      Returns:
      Whether the componentNameDeprecated field is set.

    • getComponentNameDeprecated

      @Deprecated Common.ResourceName getComponentNameDeprecated()
      Deprecated.
      viam.service.motion.v1.Plan.component_name_deprecated is deprecated. See service/motion/v1/motion.proto;l=379
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 2 [json_name = "componentNameDeprecated", deprecated = true];
      Returns:
      The componentNameDeprecated.

    • getExecutionId

      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"];
      Returns:
      The executionId.

    • getExecutionIdBytes

      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"];
      Returns:
      The bytes for executionId.

    • getStepsList

      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"];

    • getSteps

      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"];

    • getStepsCount

      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"];

    • getComponentName

      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"];
      Returns:
      The componentName.

    • getComponentNameBytes

      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"];
      Returns:
      The bytes for componentName.