Package com.viam.service.motion.v1

Interface Motion.MoveRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Common.ResourceName
    getComponentName()
    Component on the robot to move to the specified destination
    Motion.Constraints
    getConstraints()
    Constrain the way the robot will move
    Common.PoseInFrame
    getDestination()
    Destination to move to, which can a pose in the reference frame of any frame in the robot's frame system
    com.google.protobuf.Struct
    getExtra()
    Additional arguments to the method
    String
    getName()
    Name of the motion service
    com.google.protobuf.ByteString
    getNameBytes()
    Name of the motion service
    Common.WorldState
    getWorldState()
    Avoid obstacles by specifying their geometries in the world state Augment the frame system of the robot by specifying additional transforms to add to it for the duration of the Move
    boolean
    hasComponentName()
    Component on the robot to move to the specified destination
    boolean
    hasConstraints()
    Constrain the way the robot will move
    boolean
    hasDestination()
    Destination to move to, which can a pose in the reference frame of any frame in the robot's frame system
    boolean
    hasExtra()
    Additional arguments to the method
    boolean
    hasWorldState()
    Avoid obstacles by specifying their geometries in the world state Augment the frame system of the robot by specifying additional transforms to add to it for the duration of the Move

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getName

      String getName()
       Name of the motion service
      string name = 1 [json_name = "name"];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Name of the motion service
      string name = 1 [json_name = "name"];
      Returns:
      The bytes for name.

    • hasDestination

      boolean hasDestination()
       Destination to move to, which can a pose in the reference frame of any frame in the robot's frame system
      .viam.common.v1.PoseInFrame destination = 2 [json_name = "destination"];
      Returns:
      Whether the destination field is set.

    • getDestination

      Common.PoseInFrame getDestination()
       Destination to move to, which can a pose in the reference frame of any frame in the robot's frame system
      .viam.common.v1.PoseInFrame destination = 2 [json_name = "destination"];
      Returns:
      The destination.

    • hasComponentName

      boolean hasComponentName()
       Component on the robot to move to the specified destination
      .viam.common.v1.ResourceName component_name = 3 [json_name = "componentName"];
      Returns:
      Whether the componentName field is set.

    • getComponentName

      Common.ResourceName getComponentName()
       Component on the robot to move to the specified destination
      .viam.common.v1.ResourceName component_name = 3 [json_name = "componentName"];
      Returns:
      The componentName.

    • hasWorldState

      boolean hasWorldState()
       Avoid obstacles by specifying their geometries in the world state
 Augment the frame system of the robot by specifying additional transforms to add to it for the duration of the Move
      optional .viam.common.v1.WorldState world_state = 4 [json_name = "worldState"];
      Returns:
      Whether the worldState field is set.

    • getWorldState

      Common.WorldState getWorldState()
       Avoid obstacles by specifying their geometries in the world state
 Augment the frame system of the robot by specifying additional transforms to add to it for the duration of the Move
      optional .viam.common.v1.WorldState world_state = 4 [json_name = "worldState"];
      Returns:
      The worldState.

    • hasConstraints

      boolean hasConstraints()
       Constrain the way the robot will move
      optional .viam.service.motion.v1.Constraints constraints = 5 [json_name = "constraints"];
      Returns:
      Whether the constraints field is set.

    • getConstraints

      Motion.Constraints getConstraints()
       Constrain the way the robot will move
      optional .viam.service.motion.v1.Constraints constraints = 5 [json_name = "constraints"];
      Returns:
      The constraints.

    • hasExtra

      boolean hasExtra()
       Additional arguments to the method
      .google.protobuf.Struct extra = 99 [json_name = "extra"];
      Returns:
      Whether the extra field is set.

    • getExtra

      com.google.protobuf.Struct getExtra()
       Additional arguments to the method
      .google.protobuf.Struct extra = 99 [json_name = "extra"];
      Returns:
      The extra.