Package com.viam.service.motion.v1

Class Motion.MoveRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<Motion.MoveRequest,Motion.MoveRequest.Builder>
com.viam.service.motion.v1.Motion.MoveRequest
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, Motion.MoveRequestOrBuilder
Enclosing class:
Motion
public static final class Motion.MoveRequest extends com.google.protobuf.GeneratedMessageLite<Motion.MoveRequest,Motion.MoveRequest.Builder> implements Motion.MoveRequestOrBuilder
 Moves any component on the robot to a specified destination which can be from the reference frame of any other component on the robot.
Protobuf type viam.service.motion.v1.MoveRequest

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Motion.MoveRequest.Builder
    Moves any component on the robot to a specified destination which can be from the reference frame of any other component on the robot.

    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_FIELD_NUMBER
     
    static final int
    CONSTRAINTS_FIELD_NUMBER
     
    static final int
    DESTINATION_FIELD_NUMBER
     
    static final int
    EXTRA_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    WORLD_STATE_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)
     
    Common.ResourceName
    getComponentName()
    Component on the robot to move to the specified destination
    Motion.Constraints
    getConstraints()
    Constrain the way the robot will move
    static Motion.MoveRequest
    getDefaultInstance()
     
    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
    static Motion.MoveRequest.Builder
    newBuilder()
     
    static Motion.MoveRequest.Builder
    newBuilder(Motion.MoveRequest prototype)
     
    static Motion.MoveRequest
    parseDelimitedFrom(InputStream input)
     
    static Motion.MoveRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Motion.MoveRequest
    parseFrom(byte[] data)
     
    static Motion.MoveRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Motion.MoveRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static Motion.MoveRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Motion.MoveRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Motion.MoveRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Motion.MoveRequest
    parseFrom(InputStream input)
     
    static Motion.MoveRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Motion.MoveRequest
    parseFrom(ByteBuffer data)
     
    static Motion.MoveRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Motion.MoveRequest>
    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

  • Method Details

    • getName

      public String getName()
       Name of the motion service
      string name = 1 [json_name = "name"];
      Specified by:
      getName in interface Motion.MoveRequestOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Name of the motion service
      string name = 1 [json_name = "name"];
      Specified by:
      getNameBytes in interface Motion.MoveRequestOrBuilder
      Returns:
      The bytes for name.

    • hasDestination

      public 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"];
      Specified by:
      hasDestination in interface Motion.MoveRequestOrBuilder
      Returns:
      Whether the destination field is set.

    • getDestination

      public 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"];
      Specified by:
      getDestination in interface Motion.MoveRequestOrBuilder
      Returns:
      The destination.

    • hasComponentName

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

    • getComponentName

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

    • hasWorldState

      public 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"];
      Specified by:
      hasWorldState in interface Motion.MoveRequestOrBuilder
      Returns:
      Whether the worldState field is set.

    • getWorldState

      public 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"];
      Specified by:
      getWorldState in interface Motion.MoveRequestOrBuilder
      Returns:
      The worldState.

    • hasConstraints

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

    • getConstraints

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

    • hasExtra

      public boolean hasExtra()
       Additional arguments to the method
      .google.protobuf.Struct extra = 99 [json_name = "extra"];
      Specified by:
      hasExtra in interface Motion.MoveRequestOrBuilder
      Returns:
      Whether the extra field is set.

    • getExtra

      public com.google.protobuf.Struct getExtra()
       Additional arguments to the method
      .google.protobuf.Struct extra = 99 [json_name = "extra"];
      Specified by:
      getExtra in interface Motion.MoveRequestOrBuilder
      Returns:
      The extra.

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Motion.MoveRequest 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.MoveRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilder

      public static Motion.MoveRequest.Builder newBuilder()

    • newBuilder

      public static Motion.MoveRequest.Builder newBuilder(Motion.MoveRequest 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.MoveRequest,Motion.MoveRequest.Builder>

    • getDefaultInstance

      public static Motion.MoveRequest getDefaultInstance()

    • parser

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