Package com.viam.service.navigation.v1

Class Navigation.GoalStatus

java.lang.Object

com.google.protobuf.AbstractMessageLite<Navigation.GoalStatus,Navigation.GoalStatus.Builder>

com.google.protobuf.GeneratedMessageLite<Navigation.GoalStatus,Navigation.GoalStatus.Builder>

com.viam.service.navigation.v1.Navigation.GoalStatus

All Implemented Interfaces:

com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, Navigation.GoalStatusOrBuilder

Enclosing class:

Navigation

public static final class Navigation.GoalStatus
extends com.google.protobuf.GeneratedMessageLite<Navigation.GoalStatus,Navigation.GoalStatus.Builder>
implements Navigation.GoalStatusOrBuilder

 GoalStatus is one goal and its lifecycle. Returned (embedded in Status) by
 every method that starts, suspends, resumes, or cancels motion, and embedded
 in Status from GetNavigationStatus. Only the latest goal is kept. SUCCEEDED, FAILED,
 and CANCELED are terminal.
 

Protobuf type viam.service.navigation.v1.GoalStatus

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Navigation.GoalStatus.Builder	GoalStatus is one goal and its lifecycle.

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	ERROR_FIELD_NUMBER
static final int	FINISHED_AT_FIELD_NUMBER
static final int	LOCATION_FIELD_NUMBER
static final int	MODE_FIELD_NUMBER
static final int	PROGRESS_FIELD_NUMBER
static final int	ROUTE_FIELD_NUMBER
static final int	STARTED_AT_FIELD_NUMBER
static final int	STATE_FIELD_NUMBER
static final int	SUSPEND_REASON_FIELD_NUMBER
static final int	TARGET_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.GoalStatus	getDefaultInstance()
Navigation.NavError	getError()	When FAILED
com.google.protobuf.Timestamp	getFinishedAt()	Set once terminal
String	getLocation()	Set when the target is a saved location
com.google.protobuf.ByteString	getLocationBytes()	Set when the target is a saved location
Navigation.NavMode	getMode()	.viam.service.navigation.v1.NavMode mode = 2 [json_name = "mode"];
int	getModeValue()	.viam.service.navigation.v1.NavMode mode = 2 [json_name = "mode"];
Navigation.Progress	getProgress()	While ACTIVE
Navigation.RouteProgress	getRoute()	When mode == NAV_MODE_ROUTE
com.google.protobuf.Timestamp	getStartedAt()	.google.protobuf.Timestamp started_at = 9 [json_name = "startedAt"];
Navigation.GoalState	getState()	.viam.service.navigation.v1.GoalState state = 1 [json_name = "state"];
int	getStateValue()	.viam.service.navigation.v1.GoalState state = 1 [json_name = "state"];
String	getSuspendReason()	When SUSPENDED
com.google.protobuf.ByteString	getSuspendReasonBytes()	When SUSPENDED
Navigation.Position	getTarget()	For a route, the current waypoint
boolean	hasError()	When FAILED
boolean	hasFinishedAt()	Set once terminal
boolean	hasLocation()	Set when the target is a saved location
boolean	hasProgress()	While ACTIVE
boolean	hasRoute()	When mode == NAV_MODE_ROUTE
boolean	hasStartedAt()	.google.protobuf.Timestamp started_at = 9 [json_name = "startedAt"];
boolean	hasSuspendReason()	When SUSPENDED
boolean	hasTarget()	For a route, the current waypoint
static Navigation.GoalStatus.Builder	newBuilder()
static Navigation.GoalStatus.Builder	newBuilder(Navigation.GoalStatus prototype)
static Navigation.GoalStatus	parseDelimitedFrom(InputStream input)
static Navigation.GoalStatus	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Navigation.GoalStatus	parseFrom(byte[] data)
static Navigation.GoalStatus	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Navigation.GoalStatus	parseFrom(com.google.protobuf.ByteString data)
static Navigation.GoalStatus	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Navigation.GoalStatus	parseFrom(com.google.protobuf.CodedInputStream input)
static Navigation.GoalStatus	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Navigation.GoalStatus	parseFrom(InputStream input)
static Navigation.GoalStatus	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Navigation.GoalStatus	parseFrom(ByteBuffer data)
static Navigation.GoalStatus	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Navigation.GoalStatus>	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

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

See Also:

• Constant Field Values

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER

See Also:

• Constant Field Values

TARGET_FIELD_NUMBER

public static final int TARGET_FIELD_NUMBER

See Also:

• Constant Field Values

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER

See Also:

• Constant Field Values

PROGRESS_FIELD_NUMBER

public static final int PROGRESS_FIELD_NUMBER

See Also:

• Constant Field Values

ROUTE_FIELD_NUMBER

public static final int ROUTE_FIELD_NUMBER

See Also:

• Constant Field Values

SUSPEND_REASON_FIELD_NUMBER

public static final int SUSPEND_REASON_FIELD_NUMBER

See Also:

• Constant Field Values

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER

See Also:

• Constant Field Values

STARTED_AT_FIELD_NUMBER

public static final int STARTED_AT_FIELD_NUMBER

See Also:

• Constant Field Values

FINISHED_AT_FIELD_NUMBER

public static final int FINISHED_AT_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

getStateValue

public int getStateValue()

.viam.service.navigation.v1.GoalState state = 1 [json_name = "state"];

Specified by:

getStateValue in interface Navigation.GoalStatusOrBuilder

Returns:

The enum numeric value on the wire for state.

getState

public Navigation.GoalState getState()

.viam.service.navigation.v1.GoalState state = 1 [json_name = "state"];

Specified by:

getState in interface Navigation.GoalStatusOrBuilder

Returns:

The state.

getModeValue

public int getModeValue()

.viam.service.navigation.v1.NavMode mode = 2 [json_name = "mode"];

Specified by:

getModeValue in interface Navigation.GoalStatusOrBuilder

Returns:

The enum numeric value on the wire for mode.

getMode

public Navigation.NavMode getMode()

.viam.service.navigation.v1.NavMode mode = 2 [json_name = "mode"];

Specified by:

getMode in interface Navigation.GoalStatusOrBuilder

Returns:

The mode.

hasTarget

public boolean hasTarget()

 For a route, the current waypoint
 

.viam.service.navigation.v1.Position target = 3 [json_name = "target"];

Specified by:

hasTarget in interface Navigation.GoalStatusOrBuilder

Returns:

Whether the target field is set.

getTarget

public Navigation.Position getTarget()

 For a route, the current waypoint
 

.viam.service.navigation.v1.Position target = 3 [json_name = "target"];

Specified by:

getTarget in interface Navigation.GoalStatusOrBuilder

Returns:

The target.

hasLocation

public boolean hasLocation()

 Set when the target is a saved location
 

optional string location = 4 [json_name = "location"];

Specified by:

hasLocation in interface Navigation.GoalStatusOrBuilder

Returns:

Whether the location field is set.

getLocation

public String getLocation()

 Set when the target is a saved location
 

optional string location = 4 [json_name = "location"];

Specified by:

getLocation in interface Navigation.GoalStatusOrBuilder

Returns:

The location.

getLocationBytes

public com.google.protobuf.ByteString getLocationBytes()

 Set when the target is a saved location
 

optional string location = 4 [json_name = "location"];

Specified by:

getLocationBytes in interface Navigation.GoalStatusOrBuilder

Returns:

The bytes for location.

hasProgress

public boolean hasProgress()

 While ACTIVE
 

optional .viam.service.navigation.v1.Progress progress = 5 [json_name = "progress"];

Specified by:

hasProgress in interface Navigation.GoalStatusOrBuilder

Returns:

Whether the progress field is set.

getProgress

public Navigation.Progress getProgress()

 While ACTIVE
 

optional .viam.service.navigation.v1.Progress progress = 5 [json_name = "progress"];

Specified by:

getProgress in interface Navigation.GoalStatusOrBuilder

Returns:

The progress.

hasRoute

public boolean hasRoute()

 When mode == NAV_MODE_ROUTE
 

optional .viam.service.navigation.v1.RouteProgress route = 6 [json_name = "route"];

Specified by:

hasRoute in interface Navigation.GoalStatusOrBuilder

Returns:

Whether the route field is set.

getRoute

public Navigation.RouteProgress getRoute()

 When mode == NAV_MODE_ROUTE
 

optional .viam.service.navigation.v1.RouteProgress route = 6 [json_name = "route"];

Specified by:

getRoute in interface Navigation.GoalStatusOrBuilder

Returns:

The route.

hasSuspendReason

public boolean hasSuspendReason()

 When SUSPENDED
 

optional string suspend_reason = 7 [json_name = "suspendReason"];

Specified by:

hasSuspendReason in interface Navigation.GoalStatusOrBuilder

Returns:

Whether the suspendReason field is set.

getSuspendReason

public String getSuspendReason()

 When SUSPENDED
 

optional string suspend_reason = 7 [json_name = "suspendReason"];

Specified by:

getSuspendReason in interface Navigation.GoalStatusOrBuilder

Returns:

The suspendReason.

getSuspendReasonBytes

public com.google.protobuf.ByteString getSuspendReasonBytes()

 When SUSPENDED
 

optional string suspend_reason = 7 [json_name = "suspendReason"];

Specified by:

getSuspendReasonBytes in interface Navigation.GoalStatusOrBuilder

Returns:

The bytes for suspendReason.

hasError

public boolean hasError()

 When FAILED
 

optional .viam.service.navigation.v1.NavError error = 8 [json_name = "error"];

Specified by:

hasError in interface Navigation.GoalStatusOrBuilder

Returns:

Whether the error field is set.

getError

public Navigation.NavError getError()

 When FAILED
 

optional .viam.service.navigation.v1.NavError error = 8 [json_name = "error"];

Specified by:

getError in interface Navigation.GoalStatusOrBuilder

Returns:

The error.

hasStartedAt

public boolean hasStartedAt()

.google.protobuf.Timestamp started_at = 9 [json_name = "startedAt"];

Specified by:

hasStartedAt in interface Navigation.GoalStatusOrBuilder

Returns:

Whether the startedAt field is set.

getStartedAt

public com.google.protobuf.Timestamp getStartedAt()

.google.protobuf.Timestamp started_at = 9 [json_name = "startedAt"];

Specified by:

getStartedAt in interface Navigation.GoalStatusOrBuilder

Returns:

The startedAt.

hasFinishedAt

public boolean hasFinishedAt()

 Set once terminal
 

optional .google.protobuf.Timestamp finished_at = 10 [json_name = "finishedAt"];

Specified by:

hasFinishedAt in interface Navigation.GoalStatusOrBuilder

Returns:

Whether the finishedAt field is set.

getFinishedAt

public com.google.protobuf.Timestamp getFinishedAt()

 Set once terminal
 

optional .google.protobuf.Timestamp finished_at = 10 [json_name = "finishedAt"];

Specified by:

getFinishedAt in interface Navigation.GoalStatusOrBuilder

Returns:

The finishedAt.

parseFrom

public static Navigation.GoalStatus parseFrom(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Navigation.GoalStatus parseFrom(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Navigation.GoalStatus 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.GoalStatus parseFrom(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Navigation.GoalStatus parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Navigation.GoalStatus parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static Navigation.GoalStatus parseFrom(com.google.protobuf.CodedInputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilder

public static Navigation.GoalStatus.Builder newBuilder()

newBuilder

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

getDefaultInstance

public static Navigation.GoalStatus getDefaultInstance()

parser

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