Package com.viam.common.v1

Class Common.Transform

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<Common.Transform,Common.Transform.Builder>
com.viam.common.v1.Common.Transform
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, Common.TransformOrBuilder
Enclosing class:
Common
public static final class Common.Transform extends com.google.protobuf.GeneratedMessageLite<Common.Transform,Common.Transform.Builder> implements Common.TransformOrBuilder
 Transform contains a pose and two reference frames. The first reference frame is the starting reference frame, and the second reference
 frame is the observer reference frame. The second reference frame has a pose which represents the pose of an object in the first
 reference frame as observed within the second reference frame.
Protobuf type viam.common.v1.Transform

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Common.Transform.Builder
    Transform contains a pose and two reference frames.

    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
    METADATA_FIELD_NUMBER
     
    static final int
    PHYSICAL_OBJECT_FIELD_NUMBER
     
    static final int
    POSE_IN_OBSERVER_FRAME_FIELD_NUMBER
     
    static final int
    REFERENCE_FRAME_FIELD_NUMBER
     
    static final int
    UUID_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.Transform
    getDefaultInstance()
     
    com.google.protobuf.Struct
    getMetadata()
    Can hold information like color, opacity, points colors, collision_allowed, etc...
    Common.Geometry
    getPhysicalObject()
    optional .viam.common.v1.Geometry physical_object = 3 [json_name = "physicalObject"];
    Common.PoseInFrame
    getPoseInObserverFrame()
    the pose of the above reference frame with respect to a different observer reference frame
    String
    getReferenceFrame()
    the name of a given reference frame
    com.google.protobuf.ByteString
    getReferenceFrameBytes()
    the name of a given reference frame
    com.google.protobuf.ByteString
    getUuid()
    The UUID of the transform
    boolean
    hasMetadata()
    Can hold information like color, opacity, points colors, collision_allowed, etc...
    boolean
    hasPhysicalObject()
    optional .viam.common.v1.Geometry physical_object = 3 [json_name = "physicalObject"];
    boolean
    hasPoseInObserverFrame()
    the pose of the above reference frame with respect to a different observer reference frame
    static Common.Transform.Builder
    newBuilder()
     
    static Common.Transform.Builder
    newBuilder(Common.Transform prototype)
     
    static Common.Transform
    parseDelimitedFrom(InputStream input)
     
    static Common.Transform
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Common.Transform
    parseFrom(byte[] data)
     
    static Common.Transform
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Common.Transform
    parseFrom(com.google.protobuf.ByteString data)
     
    static Common.Transform
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Common.Transform
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Common.Transform
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Common.Transform
    parseFrom(InputStream input)
     
    static Common.Transform
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Common.Transform
    parseFrom(ByteBuffer data)
     
    static Common.Transform
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Common.Transform>
    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

    • REFERENCE_FRAME_FIELD_NUMBER

      public static final int REFERENCE_FRAME_FIELD_NUMBER
      See Also:

    • POSE_IN_OBSERVER_FRAME_FIELD_NUMBER

      public static final int POSE_IN_OBSERVER_FRAME_FIELD_NUMBER
      See Also:

    • PHYSICAL_OBJECT_FIELD_NUMBER

      public static final int PHYSICAL_OBJECT_FIELD_NUMBER
      See Also:

    • UUID_FIELD_NUMBER

      public static final int UUID_FIELD_NUMBER
      See Also:

    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:

  • Method Details

    • getReferenceFrame

      public String getReferenceFrame()
       the name of a given reference frame
      string reference_frame = 1 [json_name = "referenceFrame"];
      Specified by:
      getReferenceFrame in interface Common.TransformOrBuilder
      Returns:
      The referenceFrame.

    • getReferenceFrameBytes

      public com.google.protobuf.ByteString getReferenceFrameBytes()
       the name of a given reference frame
      string reference_frame = 1 [json_name = "referenceFrame"];
      Specified by:
      getReferenceFrameBytes in interface Common.TransformOrBuilder
      Returns:
      The bytes for referenceFrame.

    • hasPoseInObserverFrame

      public boolean hasPoseInObserverFrame()
       the pose of the above reference frame with respect to a different observer reference frame
      .viam.common.v1.PoseInFrame pose_in_observer_frame = 2 [json_name = "poseInObserverFrame"];
      Specified by:
      hasPoseInObserverFrame in interface Common.TransformOrBuilder
      Returns:
      Whether the poseInObserverFrame field is set.

    • getPoseInObserverFrame

      public Common.PoseInFrame getPoseInObserverFrame()
       the pose of the above reference frame with respect to a different observer reference frame
      .viam.common.v1.PoseInFrame pose_in_observer_frame = 2 [json_name = "poseInObserverFrame"];
      Specified by:
      getPoseInObserverFrame in interface Common.TransformOrBuilder
      Returns:
      The poseInObserverFrame.

    • hasPhysicalObject

      public boolean hasPhysicalObject()
      optional .viam.common.v1.Geometry physical_object = 3 [json_name = "physicalObject"];
      Specified by:
      hasPhysicalObject in interface Common.TransformOrBuilder
      Returns:
      Whether the physicalObject field is set.

    • getPhysicalObject

      public Common.Geometry getPhysicalObject()
      optional .viam.common.v1.Geometry physical_object = 3 [json_name = "physicalObject"];
      Specified by:
      getPhysicalObject in interface Common.TransformOrBuilder
      Returns:
      The physicalObject.

    • getUuid

      public com.google.protobuf.ByteString getUuid()
       The UUID of the transform
      bytes uuid = 4 [json_name = "uuid"];
      Specified by:
      getUuid in interface Common.TransformOrBuilder
      Returns:
      The uuid.

    • hasMetadata

      public boolean hasMetadata()
       Can hold information like color, opacity, points colors, collision_allowed, etc...
      optional .google.protobuf.Struct metadata = 5 [json_name = "metadata"];
      Specified by:
      hasMetadata in interface Common.TransformOrBuilder
      Returns:
      Whether the metadata field is set.

    • getMetadata

      public com.google.protobuf.Struct getMetadata()
       Can hold information like color, opacity, points colors, collision_allowed, etc...
      optional .google.protobuf.Struct metadata = 5 [json_name = "metadata"];
      Specified by:
      getMetadata in interface Common.TransformOrBuilder
      Returns:
      The metadata.

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilder

      public static Common.Transform.Builder newBuilder()

    • newBuilder

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

    • getDefaultInstance

      public static Common.Transform getDefaultInstance()

    • parser

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