Package com.viam.service.motion.v1

Class Motion.MoveOnGlobeRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<Motion.MoveOnGlobeRequest,Motion.MoveOnGlobeRequest.Builder>
com.viam.service.motion.v1.Motion.MoveOnGlobeRequest
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, Motion.MoveOnGlobeRequestOrBuilder
Enclosing class:
Motion
public static final class Motion.MoveOnGlobeRequest extends com.google.protobuf.GeneratedMessageLite<Motion.MoveOnGlobeRequest,Motion.MoveOnGlobeRequest.Builder> implements Motion.MoveOnGlobeRequestOrBuilder
Protobuf type viam.service.motion.v1.MoveOnGlobeRequest

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DESTINATION_FIELD_NUMBER

      public static final int DESTINATION_FIELD_NUMBER
      See Also:

    • HEADING_FIELD_NUMBER

      public static final int HEADING_FIELD_NUMBER
      See Also:

    • COMPONENT_NAME_DEPRECATED_FIELD_NUMBER

      public static final int COMPONENT_NAME_DEPRECATED_FIELD_NUMBER
      See Also:

    • MOVEMENT_SENSOR_NAME_DEPRECATED_FIELD_NUMBER

      public static final int MOVEMENT_SENSOR_NAME_DEPRECATED_FIELD_NUMBER
      See Also:

    • OBSTACLES_FIELD_NUMBER

      public static final int OBSTACLES_FIELD_NUMBER
      See Also:

    • MOTION_CONFIGURATION_FIELD_NUMBER

      public static final int MOTION_CONFIGURATION_FIELD_NUMBER
      See Also:

    • BOUNDING_REGIONS_FIELD_NUMBER

      public static final int BOUNDING_REGIONS_FIELD_NUMBER
      See Also:

    • COMPONENT_NAME_FIELD_NUMBER

      public static final int COMPONENT_NAME_FIELD_NUMBER
      See Also:

    • MOVEMENT_SENSOR_NAME_FIELD_NUMBER

      public static final int MOVEMENT_SENSOR_NAME_FIELD_NUMBER
      See Also:

    • EXTRA_FIELD_NUMBER

      public static final int EXTRA_FIELD_NUMBER
      See Also:

  • Method Details

    • getName

      public String getName()
       Name of the motion service
      string name = 1 [json_name = "name"];
      Specified by:
      getName in interface Motion.MoveOnGlobeRequestOrBuilder
      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.MoveOnGlobeRequestOrBuilder
      Returns:
      The bytes for name.

    • hasDestination

      public boolean hasDestination()
       Destination, encoded as a GeoPoint
      .viam.common.v1.GeoPoint destination = 2 [json_name = "destination"];
      Specified by:
      hasDestination in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      Whether the destination field is set.

    • getDestination

      public Common.GeoPoint getDestination()
       Destination, encoded as a GeoPoint
      .viam.common.v1.GeoPoint destination = 2 [json_name = "destination"];
      Specified by:
      getDestination in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The destination.

    • hasHeading

      public boolean hasHeading()
       Optional compass heading to achieve at the destination, in degrees [0-360)
      optional double heading = 3 [json_name = "heading"];
      Specified by:
      hasHeading in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      Whether the heading field is set.

    • getHeading

      public double getHeading()
       Optional compass heading to achieve at the destination, in degrees [0-360)
      optional double heading = 3 [json_name = "heading"];
      Specified by:
      getHeading in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The heading.

    • hasComponentNameDeprecated

      @Deprecated public boolean hasComponentNameDeprecated()
      Deprecated.
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 4 [json_name = "componentNameDeprecated", deprecated = true];
      Specified by:
      hasComponentNameDeprecated in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      Whether the componentNameDeprecated field is set.

    • getComponentNameDeprecated

      @Deprecated public Common.ResourceName getComponentNameDeprecated()
      Deprecated.
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 4 [json_name = "componentNameDeprecated", deprecated = true];
      Specified by:
      getComponentNameDeprecated in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The componentNameDeprecated.

    • hasMovementSensorNameDeprecated

      @Deprecated public boolean hasMovementSensorNameDeprecated()
      Deprecated.
       Deprecated, use movement_sensor_name field.
      .viam.common.v1.ResourceName movement_sensor_name_deprecated = 5 [json_name = "movementSensorNameDeprecated", deprecated = true];
      Specified by:
      hasMovementSensorNameDeprecated in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      Whether the movementSensorNameDeprecated field is set.

    • getMovementSensorNameDeprecated

      @Deprecated public Common.ResourceName getMovementSensorNameDeprecated()
      Deprecated.
       Deprecated, use movement_sensor_name field.
      .viam.common.v1.ResourceName movement_sensor_name_deprecated = 5 [json_name = "movementSensorNameDeprecated", deprecated = true];
      Specified by:
      getMovementSensorNameDeprecated in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The movementSensorNameDeprecated.

    • getObstaclesList

      public List<Common.GeoGeometry> getObstaclesList()
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.GeoGeometry obstacles = 6 [json_name = "obstacles"];
      Specified by:
      getObstaclesList in interface Motion.MoveOnGlobeRequestOrBuilder

    • getObstaclesOrBuilderList

      public List<? extends Common.GeoGeometryOrBuilder> getObstaclesOrBuilderList()
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.GeoGeometry obstacles = 6 [json_name = "obstacles"];

    • getObstaclesCount

      public int getObstaclesCount()
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.GeoGeometry obstacles = 6 [json_name = "obstacles"];
      Specified by:
      getObstaclesCount in interface Motion.MoveOnGlobeRequestOrBuilder

    • getObstacles

      public Common.GeoGeometry getObstacles(int index)
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.GeoGeometry obstacles = 6 [json_name = "obstacles"];
      Specified by:
      getObstacles in interface Motion.MoveOnGlobeRequestOrBuilder

    • getObstaclesOrBuilder

      public Common.GeoGeometryOrBuilder getObstaclesOrBuilder(int index)
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.GeoGeometry obstacles = 6 [json_name = "obstacles"];

    • hasMotionConfiguration

      public boolean hasMotionConfiguration()
       Optional set of motion configuration options
      optional .viam.service.motion.v1.MotionConfiguration motion_configuration = 7 [json_name = "motionConfiguration"];
      Specified by:
      hasMotionConfiguration in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      Whether the motionConfiguration field is set.

    • getMotionConfiguration

      public Motion.MotionConfiguration getMotionConfiguration()
       Optional set of motion configuration options
      optional .viam.service.motion.v1.MotionConfiguration motion_configuration = 7 [json_name = "motionConfiguration"];
      Specified by:
      getMotionConfiguration in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The motionConfiguration.

    • getBoundingRegionsList

      public List<Common.GeoGeometry> getBoundingRegionsList()
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];
      Specified by:
      getBoundingRegionsList in interface Motion.MoveOnGlobeRequestOrBuilder

    • getBoundingRegionsOrBuilderList

      public List<? extends Common.GeoGeometryOrBuilder> getBoundingRegionsOrBuilderList()
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];

    • getBoundingRegionsCount

      public int getBoundingRegionsCount()
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];
      Specified by:
      getBoundingRegionsCount in interface Motion.MoveOnGlobeRequestOrBuilder

    • getBoundingRegions

      public Common.GeoGeometry getBoundingRegions(int index)
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];
      Specified by:
      getBoundingRegions in interface Motion.MoveOnGlobeRequestOrBuilder

    • getBoundingRegionsOrBuilder

      public Common.GeoGeometryOrBuilder getBoundingRegionsOrBuilder(int index)
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];

    • getComponentName

      public String getComponentName()
       Component on the robot to move to the specified destination
      string component_name = 9 [json_name = "componentName"];
      Specified by:
      getComponentName in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The componentName.

    • getComponentNameBytes

      public com.google.protobuf.ByteString getComponentNameBytes()
       Component on the robot to move to the specified destination
      string component_name = 9 [json_name = "componentName"];
      Specified by:
      getComponentNameBytes in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The bytes for componentName.

    • getMovementSensorName

      public String getMovementSensorName()
       Name of the movement sensor which will be used to check robot location
      string movement_sensor_name = 10 [json_name = "movementSensorName"];
      Specified by:
      getMovementSensorName in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The movementSensorName.

    • getMovementSensorNameBytes

      public com.google.protobuf.ByteString getMovementSensorNameBytes()
       Name of the movement sensor which will be used to check robot location
      string movement_sensor_name = 10 [json_name = "movementSensorName"];
      Specified by:
      getMovementSensorNameBytes in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The bytes for movementSensorName.

    • hasExtra

      public boolean hasExtra()
       Additional arguments to the method
      .google.protobuf.Struct extra = 99 [json_name = "extra"];
      Specified by:
      hasExtra in interface Motion.MoveOnGlobeRequestOrBuilder
      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.MoveOnGlobeRequestOrBuilder
      Returns:
      The extra.

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilder

      public static Motion.MoveOnGlobeRequest.Builder newBuilder()

    • newBuilder

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

    • getDefaultInstance

      public static Motion.MoveOnGlobeRequest getDefaultInstance()

    • parser

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