Package com.viam.service.navigation.v1

Class Navigation.Status

java.lang.Object
com.google.protobuf.AbstractMessageLite<Navigation.Status,Navigation.Status.Builder>
com.google.protobuf.GeneratedMessageLite<Navigation.Status,Navigation.Status.Builder>
com.viam.service.navigation.v1.Navigation.Status
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, Navigation.StatusOrBuilder
Enclosing class:
Navigation
public static final class Navigation.Status extends com.google.protobuf.GeneratedMessageLite<Navigation.Status,Navigation.Status.Builder> implements Navigation.StatusOrBuilder
 Status is the robot navigation state returned by GetNavigationStatus and by methods that
 start, suspend, or resume motion. The robot is idle when goal is unset or
 goal.state is terminal. It is moving when goal.state == GOAL_STATE_ACTIVE.
 Methods that start motion fail while localized is false.
Protobuf type viam.service.navigation.v1.Status

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Navigation.Status.Builder
    Status is the robot navigation state returned by GetNavigationStatus and by methods that start, suspend, or resume motion.

    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>, 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
    EXTRA_FIELD_NUMBER
     
    static final int
    GOAL_FIELD_NUMBER
     
    static final int
    LOCALIZED_FIELD_NUMBER
     
    static final int
    POSITION_FIELD_NUMBER
     
    static final int
    UPDATED_AT_FIELD_NUMBER
     
    static final int
    VELOCITY_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 Navigation.Status
    getDefaultInstance()
     
    com.google.protobuf.Struct
    getExtra()
    Backend-specific diagnostics
    Navigation.GoalStatus
    getGoal()
    Latest goal; unset until the first one
    boolean
    getLocalized()
    Pose is trusted; false blocks new goals
    Navigation.Position
    getPosition()
    Same as GetPosition
    com.google.protobuf.Timestamp
    getUpdatedAt()
    .google.protobuf.Timestamp updated_at = 5 [json_name = "updatedAt"];
    Navigation.Velocity
    getVelocity()
    Current body-frame velocity; zero when stopped
    boolean
    hasExtra()
    Backend-specific diagnostics
    boolean
    hasGoal()
    Latest goal; unset until the first one
    boolean
    hasPosition()
    Same as GetPosition
    boolean
    hasUpdatedAt()
    .google.protobuf.Timestamp updated_at = 5 [json_name = "updatedAt"];
    boolean
    hasVelocity()
    Current body-frame velocity; zero when stopped
    static Navigation.Status.Builder
    newBuilder()
     
    static Navigation.Status.Builder
    newBuilder(Navigation.Status prototype)
     
    static Navigation.Status
    parseDelimitedFrom(InputStream input)
     
    static Navigation.Status
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Navigation.Status
    parseFrom(byte[] data)
     
    static Navigation.Status
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Navigation.Status
    parseFrom(com.google.protobuf.ByteString data)
     
    static Navigation.Status
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Navigation.Status
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Navigation.Status
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Navigation.Status
    parseFrom(InputStream input)
     
    static Navigation.Status
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Navigation.Status
    parseFrom(ByteBuffer data)
     
    static Navigation.Status
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Navigation.Status>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, 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

    • hasPosition

      public boolean hasPosition()
       Same as GetPosition
      .viam.service.navigation.v1.Position position = 1 [json_name = "position"];
      Specified by:
      hasPosition in interface Navigation.StatusOrBuilder
      Returns:
      Whether the position field is set.

    • getPosition

      public Navigation.Position getPosition()
       Same as GetPosition
      .viam.service.navigation.v1.Position position = 1 [json_name = "position"];
      Specified by:
      getPosition in interface Navigation.StatusOrBuilder
      Returns:
      The position.

    • getLocalized

      public boolean getLocalized()
       Pose is trusted; false blocks new goals
      bool localized = 2 [json_name = "localized"];
      Specified by:
      getLocalized in interface Navigation.StatusOrBuilder
      Returns:
      The localized.

    • hasVelocity

      public boolean hasVelocity()
       Current body-frame velocity; zero when stopped
      .viam.service.navigation.v1.Velocity velocity = 3 [json_name = "velocity"];
      Specified by:
      hasVelocity in interface Navigation.StatusOrBuilder
      Returns:
      Whether the velocity field is set.

    • getVelocity

      public Navigation.Velocity getVelocity()
       Current body-frame velocity; zero when stopped
      .viam.service.navigation.v1.Velocity velocity = 3 [json_name = "velocity"];
      Specified by:
      getVelocity in interface Navigation.StatusOrBuilder
      Returns:
      The velocity.

    • hasGoal

      public boolean hasGoal()
       Latest goal; unset until the first one
      optional .viam.service.navigation.v1.GoalStatus goal = 4 [json_name = "goal"];
      Specified by:
      hasGoal in interface Navigation.StatusOrBuilder
      Returns:
      Whether the goal field is set.

    • getGoal

      public Navigation.GoalStatus getGoal()
       Latest goal; unset until the first one
      optional .viam.service.navigation.v1.GoalStatus goal = 4 [json_name = "goal"];
      Specified by:
      getGoal in interface Navigation.StatusOrBuilder
      Returns:
      The goal.

    • hasUpdatedAt

      public boolean hasUpdatedAt()
      .google.protobuf.Timestamp updated_at = 5 [json_name = "updatedAt"];
      Specified by:
      hasUpdatedAt in interface Navigation.StatusOrBuilder
      Returns:
      Whether the updatedAt field is set.

    • getUpdatedAt

      public com.google.protobuf.Timestamp getUpdatedAt()
      .google.protobuf.Timestamp updated_at = 5 [json_name = "updatedAt"];
      Specified by:
      getUpdatedAt in interface Navigation.StatusOrBuilder
      Returns:
      The updatedAt.

    • hasExtra

      public boolean hasExtra()
       Backend-specific diagnostics
      .google.protobuf.Struct extra = 99 [json_name = "extra"];
      Specified by:
      hasExtra in interface Navigation.StatusOrBuilder
      Returns:
      Whether the extra field is set.

    • getExtra

      public com.google.protobuf.Struct getExtra()
       Backend-specific diagnostics
      .google.protobuf.Struct extra = 99 [json_name = "extra"];
      Specified by:
      getExtra in interface Navigation.StatusOrBuilder
      Returns:
      The extra.

    • parseFrom

      public static Navigation.Status parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Navigation.Status parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Navigation.Status parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Navigation.Status parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static Navigation.Status parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilder

      public static Navigation.Status.Builder newBuilder()

    • newBuilder

      public static Navigation.Status.Builder newBuilder(Navigation.Status 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<Navigation.Status,Navigation.Status.Builder>

    • getDefaultInstance

      public static Navigation.Status getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Navigation.Status> parser()