Package com.viam.common.v1

Class Common.WorldState

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<Common.WorldState,Common.WorldState.Builder>
com.viam.common.v1.Common.WorldState
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, Common.WorldStateOrBuilder
Enclosing class:
Common
public static final class Common.WorldState extends com.google.protobuf.GeneratedMessageLite<Common.WorldState,Common.WorldState.Builder> implements Common.WorldStateOrBuilder
 WorldState contains information about the physical environment around a given robot. All of the fields within this message are optional,
 they can include information about the physical dimensions of an obstacle, the freespace of a robot, and any desired transforms between a
 given reference frame and a new target reference frame.
Protobuf type viam.common.v1.WorldState

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Common.WorldState.Builder
    WorldState contains information about the physical environment around a given 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
    OBSTACLES_FIELD_NUMBER
     
    static final int
    TRANSFORMS_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.WorldState
    getDefaultInstance()
     
    Common.GeometriesInFrame
    getObstacles(int index)
    a list of obstacles expressed as a geometry and the reference frame in which it was observed; this field is optional
    int
    getObstaclesCount()
    a list of obstacles expressed as a geometry and the reference frame in which it was observed; this field is optional
    List<Common.GeometriesInFrame>
    getObstaclesList()
    a list of obstacles expressed as a geometry and the reference frame in which it was observed; this field is optional
    Common.GeometriesInFrameOrBuilder
    getObstaclesOrBuilder(int index)
    a list of obstacles expressed as a geometry and the reference frame in which it was observed; this field is optional
    List<? extends Common.GeometriesInFrameOrBuilder>
    getObstaclesOrBuilderList()
    a list of obstacles expressed as a geometry and the reference frame in which it was observed; this field is optional
    Common.Transform
    getTransforms(int index)
    a list of Transforms, optionally with geometries.
    int
    getTransformsCount()
    a list of Transforms, optionally with geometries.
    List<Common.Transform>
    getTransformsList()
    a list of Transforms, optionally with geometries.
    Common.TransformOrBuilder
    getTransformsOrBuilder(int index)
    a list of Transforms, optionally with geometries.
    List<? extends Common.TransformOrBuilder>
    getTransformsOrBuilderList()
    a list of Transforms, optionally with geometries.
    static Common.WorldState.Builder
    newBuilder()
     
    static Common.WorldState.Builder
    newBuilder(Common.WorldState prototype)
     
    static Common.WorldState
    parseDelimitedFrom(InputStream input)
     
    static Common.WorldState
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Common.WorldState
    parseFrom(byte[] data)
     
    static Common.WorldState
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Common.WorldState
    parseFrom(com.google.protobuf.ByteString data)
     
    static Common.WorldState
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Common.WorldState
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Common.WorldState
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Common.WorldState
    parseFrom(InputStream input)
     
    static Common.WorldState
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Common.WorldState
    parseFrom(ByteBuffer data)
     
    static Common.WorldState
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Common.WorldState>
    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

    • OBSTACLES_FIELD_NUMBER

      public static final int OBSTACLES_FIELD_NUMBER
      See Also:

    • TRANSFORMS_FIELD_NUMBER

      public static final int TRANSFORMS_FIELD_NUMBER
      See Also:

  • Method Details

    • getObstaclesList

      public List<Common.GeometriesInFrame> getObstaclesList()
       a list of obstacles expressed as a geometry and the reference frame in which it was observed; this field is optional
      repeated .viam.common.v1.GeometriesInFrame obstacles = 1 [json_name = "obstacles"];
      Specified by:
      getObstaclesList in interface Common.WorldStateOrBuilder

    • getObstaclesOrBuilderList

      public List<? extends Common.GeometriesInFrameOrBuilder> getObstaclesOrBuilderList()
       a list of obstacles expressed as a geometry and the reference frame in which it was observed; this field is optional
      repeated .viam.common.v1.GeometriesInFrame obstacles = 1 [json_name = "obstacles"];

    • getObstaclesCount

      public int getObstaclesCount()
       a list of obstacles expressed as a geometry and the reference frame in which it was observed; this field is optional
      repeated .viam.common.v1.GeometriesInFrame obstacles = 1 [json_name = "obstacles"];
      Specified by:
      getObstaclesCount in interface Common.WorldStateOrBuilder

    • getObstacles

      public Common.GeometriesInFrame getObstacles(int index)
       a list of obstacles expressed as a geometry and the reference frame in which it was observed; this field is optional
      repeated .viam.common.v1.GeometriesInFrame obstacles = 1 [json_name = "obstacles"];
      Specified by:
      getObstacles in interface Common.WorldStateOrBuilder

    • getObstaclesOrBuilder

      public Common.GeometriesInFrameOrBuilder getObstaclesOrBuilder(int index)
       a list of obstacles expressed as a geometry and the reference frame in which it was observed; this field is optional
      repeated .viam.common.v1.GeometriesInFrame obstacles = 1 [json_name = "obstacles"];

    • getTransformsList

      public List<Common.Transform> getTransformsList()
       a list of Transforms, optionally with geometries. Used as supplemental transforms to transform a pose from one reference frame to
 another, or to attach moving geometries to the frame system. This field is optional
      repeated .viam.common.v1.Transform transforms = 3 [json_name = "transforms"];
      Specified by:
      getTransformsList in interface Common.WorldStateOrBuilder

    • getTransformsOrBuilderList

      public List<? extends Common.TransformOrBuilder> getTransformsOrBuilderList()
       a list of Transforms, optionally with geometries. Used as supplemental transforms to transform a pose from one reference frame to
 another, or to attach moving geometries to the frame system. This field is optional
      repeated .viam.common.v1.Transform transforms = 3 [json_name = "transforms"];

    • getTransformsCount

      public int getTransformsCount()
       a list of Transforms, optionally with geometries. Used as supplemental transforms to transform a pose from one reference frame to
 another, or to attach moving geometries to the frame system. This field is optional
      repeated .viam.common.v1.Transform transforms = 3 [json_name = "transforms"];
      Specified by:
      getTransformsCount in interface Common.WorldStateOrBuilder

    • getTransforms

      public Common.Transform getTransforms(int index)
       a list of Transforms, optionally with geometries. Used as supplemental transforms to transform a pose from one reference frame to
 another, or to attach moving geometries to the frame system. This field is optional
      repeated .viam.common.v1.Transform transforms = 3 [json_name = "transforms"];
      Specified by:
      getTransforms in interface Common.WorldStateOrBuilder

    • getTransformsOrBuilder

      public Common.TransformOrBuilder getTransformsOrBuilder(int index)
       a list of Transforms, optionally with geometries. Used as supplemental transforms to transform a pose from one reference frame to
 another, or to attach moving geometries to the frame system. This field is optional
      repeated .viam.common.v1.Transform transforms = 3 [json_name = "transforms"];

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilder

      public static Common.WorldState.Builder newBuilder()

    • newBuilder

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

    • getDefaultInstance

      public static Common.WorldState getDefaultInstance()

    • parser

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