Package com.viam.service.motion.v1

Interface Motion.PlanStatusOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
Motion.PlanStatus, Motion.PlanStatus.Builder
Enclosing class:
Motion
public static interface Motion.PlanStatusOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getReason()
    The reason for the state change.
    com.google.protobuf.ByteString
    getReasonBytes()
    The reason for the state change.
    Motion.PlanState
    getState()
    The state of the plan execution
    int
    getStateValue()
    The state of the plan execution
    com.google.protobuf.Timestamp
    getTimestamp()
    The time the executing plan transtioned to the state
    boolean
    hasReason()
    The reason for the state change.
    boolean
    hasTimestamp()
    The time the executing plan transtioned to the state

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getStateValue

      int getStateValue()
       The state of the plan execution
      .viam.service.motion.v1.PlanState state = 1 [json_name = "state"];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      Motion.PlanState getState()
       The state of the plan execution
      .viam.service.motion.v1.PlanState state = 1 [json_name = "state"];
      Returns:
      The state.

    • hasTimestamp

      boolean hasTimestamp()
       The time the executing plan transtioned to the state
      .google.protobuf.Timestamp timestamp = 2 [json_name = "timestamp"];
      Returns:
      Whether the timestamp field is set.

    • getTimestamp

      com.google.protobuf.Timestamp getTimestamp()
       The time the executing plan transtioned to the state
      .google.protobuf.Timestamp timestamp = 2 [json_name = "timestamp"];
      Returns:
      The timestamp.

    • hasReason

      boolean hasReason()
       The reason for the state change. If motion plan failed
 this will return the error message.
 If motion needed to re-plan, this will return
 the re-plan reason.
      optional string reason = 3 [json_name = "reason"];
      Returns:
      Whether the reason field is set.

    • getReason

      String getReason()
       The reason for the state change. If motion plan failed
 this will return the error message.
 If motion needed to re-plan, this will return
 the re-plan reason.
      optional string reason = 3 [json_name = "reason"];
      Returns:
      The reason.

    • getReasonBytes

      com.google.protobuf.ByteString getReasonBytes()
       The reason for the state change. If motion plan failed
 this will return the error message.
 If motion needed to re-plan, this will return
 the re-plan reason.
      optional string reason = 3 [json_name = "reason"];
      Returns:
      The bytes for reason.