Package com.viam.robot.v1

Interface Robot.GetPoseRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
Robot.GetPoseRequest, Robot.GetPoseRequest.Builder
Enclosing class:
Robot
public static interface Robot.GetPoseRequestOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getComponentName()
    the component whose pose is being requested
    com.google.protobuf.ByteString
    getComponentNameBytes()
    the component whose pose is being requested
    String
    getDestinationFrame()
    the reference frame in which the component's pose should be provided, if unset this defaults to the "world" reference frame
    com.google.protobuf.ByteString
    getDestinationFrameBytes()
    the reference frame in which the component's pose should be provided, if unset this defaults to the "world" reference frame
    com.google.protobuf.Struct
    getExtra()
    Additional arguments to the method
    Common.Transform
    getSupplementalTransforms(int index)
    pose information on any additional reference frames that are needed to compute the component's pose
    int
    getSupplementalTransformsCount()
    pose information on any additional reference frames that are needed to compute the component's pose
    List<Common.Transform>
    getSupplementalTransformsList()
    pose information on any additional reference frames that are needed to compute the component's pose
    boolean
    hasExtra()
    Additional arguments to the method

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getComponentName

      String getComponentName()
       the component whose pose is being requested
      string component_name = 1 [json_name = "componentName"];
      Returns:
      The componentName.

    • getComponentNameBytes

      com.google.protobuf.ByteString getComponentNameBytes()
       the component whose pose is being requested
      string component_name = 1 [json_name = "componentName"];
      Returns:
      The bytes for componentName.

    • getDestinationFrame

      String getDestinationFrame()
       the reference frame in which the component's pose
 should be provided, if unset this defaults
 to the "world" reference frame
      string destination_frame = 2 [json_name = "destinationFrame"];
      Returns:
      The destinationFrame.

    • getDestinationFrameBytes

      com.google.protobuf.ByteString getDestinationFrameBytes()
       the reference frame in which the component's pose
 should be provided, if unset this defaults
 to the "world" reference frame
      string destination_frame = 2 [json_name = "destinationFrame"];
      Returns:
      The bytes for destinationFrame.

    • getSupplementalTransformsList

      List<Common.Transform> getSupplementalTransformsList()
       pose information on any additional reference frames that are needed
 to compute the component's pose
      repeated .viam.common.v1.Transform supplemental_transforms = 3 [json_name = "supplementalTransforms"];

    • getSupplementalTransforms

      Common.Transform getSupplementalTransforms(int index)
       pose information on any additional reference frames that are needed
 to compute the component's pose
      repeated .viam.common.v1.Transform supplemental_transforms = 3 [json_name = "supplementalTransforms"];

    • getSupplementalTransformsCount

      int getSupplementalTransformsCount()
       pose information on any additional reference frames that are needed
 to compute the component's pose
      repeated .viam.common.v1.Transform supplemental_transforms = 3 [json_name = "supplementalTransforms"];

    • 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.