Package com.viam.common.v1

Class Common.Pose

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<Common.Pose,Common.Pose.Builder>
com.viam.common.v1.Common.Pose
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, Common.PoseOrBuilder
Enclosing class:
Common
public static final class Common.Pose extends com.google.protobuf.GeneratedMessageLite<Common.Pose,Common.Pose.Builder> implements Common.PoseOrBuilder
 Pose is a combination of location and orientation.
 Location is expressed as distance which is represented by x , y, z coordinates. Orientation is expressed as an orientation vector which
 is represented by o_x, o_y, o_z and theta. The o_x, o_y, o_z coordinates represent the point on the cartesian unit sphere that the end of
 the arm is pointing to (with the origin as reference). That unit vector forms an axis around which theta rotates. This means that
 incrementing / decrementing theta will perform an inline rotation of the end effector.
 Theta is defined as rotation between two planes: the first being defined by the origin, the point (0,0,1), and the rx, ry, rz point, and the
 second being defined by the origin, the rx, ry, rz point and the local Z axis. Therefore, if theta is kept at zero as the north/south pole
 is circled, the Roll will correct itself to remain in-line.
Protobuf type viam.common.v1.Pose

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Common.Pose.Builder
    Pose is a combination of location and orientation.

    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
    O_X_FIELD_NUMBER
     
    static final int
    O_Y_FIELD_NUMBER
     
    static final int
    O_Z_FIELD_NUMBER
     
    static final int
    THETA_FIELD_NUMBER
     
    static final int
    X_FIELD_NUMBER
     
    static final int
    Y_FIELD_NUMBER
     
    static final int
    Z_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)
     
    static Common.Pose
    getDefaultInstance()
     
    double
    getOX()
    z component of a vector defining axis of rotation
    double
    getOY()
    x component of a vector defining axis of rotation
    double
    getOZ()
    y component of a vector defining axis of rotation
    double
    getTheta()
    degrees
    double
    getX()
    millimeters from the origin
    double
    getY()
    millimeters from the origin
    double
    getZ()
    millimeters from the origin
    static Common.Pose.Builder
    newBuilder()
     
    static Common.Pose.Builder
    newBuilder(Common.Pose prototype)
     
    static Common.Pose
    parseDelimitedFrom(InputStream input)
     
    static Common.Pose
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Common.Pose
    parseFrom(byte[] data)
     
    static Common.Pose
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Common.Pose
    parseFrom(com.google.protobuf.ByteString data)
     
    static Common.Pose
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Common.Pose
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Common.Pose
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Common.Pose
    parseFrom(InputStream input)
     
    static Common.Pose
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Common.Pose
    parseFrom(ByteBuffer data)
     
    static Common.Pose
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Common.Pose>
    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

    • getX

      public double getX()
       millimeters from the origin
      double x = 1 [json_name = "x"];
      Specified by:
      getX in interface Common.PoseOrBuilder
      Returns:
      The x.

    • getY

      public double getY()
       millimeters from the origin
      double y = 2 [json_name = "y"];
      Specified by:
      getY in interface Common.PoseOrBuilder
      Returns:
      The y.

    • getZ

      public double getZ()
       millimeters from the origin
      double z = 3 [json_name = "z"];
      Specified by:
      getZ in interface Common.PoseOrBuilder
      Returns:
      The z.

    • getOX

      public double getOX()
       z component of a vector defining axis of rotation
      double o_x = 4 [json_name = "oX"];
      Specified by:
      getOX in interface Common.PoseOrBuilder
      Returns:
      The oX.

    • getOY

      public double getOY()
       x component of a vector defining axis of rotation
      double o_y = 5 [json_name = "oY"];
      Specified by:
      getOY in interface Common.PoseOrBuilder
      Returns:
      The oY.

    • getOZ

      public double getOZ()
       y component of a vector defining axis of rotation
      double o_z = 6 [json_name = "oZ"];
      Specified by:
      getOZ in interface Common.PoseOrBuilder
      Returns:
      The oZ.

    • getTheta

      public double getTheta()
       degrees
      double theta = 7 [json_name = "theta"];
      Specified by:
      getTheta in interface Common.PoseOrBuilder
      Returns:
      The theta.

    • parseFrom

      public static Common.Pose parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Common.Pose parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Common.Pose parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Common.Pose parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static Common.Pose parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilder

      public static Common.Pose.Builder newBuilder()

    • newBuilder

      public static Common.Pose.Builder newBuilder(Common.Pose 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<Common.Pose,Common.Pose.Builder>

    • getDefaultInstance

      public static Common.Pose getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Common.Pose> parser()