Class Path

A user provided destination and the set of geopoints that the robot is expected to take to get there

Generated

from message viam.service.navigation.v1.Path

Hierarchy

Message<navigationApi.Path>
- Path

Index

Constructors

constructor

new Path(data?: PartialMessage<navigationApi.Path>): navigationApi.Path
Parameters
- Optionaldata: PartialMessage<navigationApi.Path>
Returns navigationApi.Path
Overrides Message<Path>.constructor

Properties

destinationWaypointId

destinationWaypointId: string

The id of the user specified waypoint

Generated

from field: string destination_waypoint_id = 1;

geopoints

geopoints: commonApi.GeoPoint[]

List of geopoints that the motion planner output to reach the destination The first geopoint is the starting position of the robot for that path

Generated

from field: repeated viam.common.v1.GeoPoint geopoints = 2;

`Static` `Readonly`fields

fields: FieldList

`Static` `Readonly`runtime

runtime: ProtoRuntime

`Static` `Readonly`typeName

typeName: "viam.service.navigation.v1.Path"

Methods

clone

clone(): navigationApi.Path
Create a deep copy.

Returns navigationApi.Path
Inherited from Message.clone

equals

equals(
    other:
        | navigationApi.Path
        | PlainMessage<navigationApi.Path>
        | null
        | undefined,
): boolean
Compare with a message of the same type. Note that this function disregards extensions and unknown fields.
Parameters
- other: navigationApi.Path | PlainMessage<navigationApi.Path> | null | undefined
Returns boolean
Inherited from Message.equals

fromBinary

fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): this
Parse from binary data, merging fields.

Repeated fields are appended. Map entries are added, overwriting existing keys.

If a message field is already present, it will be merged with the new data.
Parameters
- bytes: Uint8Array
- Optionaloptions: Partial<BinaryReadOptions>
Returns this
Inherited from Message.fromBinary

fromJson

fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): this
Parse a message from a JSON value.
Parameters
- jsonValue: JsonValue
- Optionaloptions: Partial<JsonReadOptions>
Returns this
Inherited from Message.fromJson

fromJsonString

fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): this
Parse a message from a JSON string.
Parameters
- jsonString: string
- Optionaloptions: Partial<JsonReadOptions>
Returns this
Inherited from Message.fromJsonString

getType

getType(): MessageType<navigationApi.Path>
Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

Returns MessageType<navigationApi.Path>
Inherited from Message.getType

toBinary

toBinary(options?: Partial<BinaryWriteOptions>): Uint8Array
Serialize the message to binary data.
Parameters
- Optionaloptions: Partial<BinaryWriteOptions>
Returns Uint8Array
Inherited from Message.toBinary

toJson

toJson(options?: Partial<JsonWriteOptions>): JsonValue
Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().
Parameters
- Optionaloptions: Partial<JsonWriteOptions>
Returns JsonValue
Inherited from Message.toJson

`Protected`toJSON

toJSON(): JsonValue
Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

Returns JsonValue
Inherited from Message.toJSON

toJsonString

toJsonString(options?: Partial<JsonWriteStringOptions>): string
Serialize the message to a JSON string.
Parameters
- Optionaloptions: Partial<JsonWriteStringOptions>
Returns string
Inherited from Message.toJsonString

`Static`equals

equals(
a: navigationApi.Path | PlainMessage<navigationApi.Path> | undefined,
b: navigationApi.Path | PlainMessage<navigationApi.Path> | undefined,
): boolean
Parameters
- a: navigationApi.Path | PlainMessage<navigationApi.Path> | undefined
- b: navigationApi.Path | PlainMessage<navigationApi.Path> | undefined
Returns boolean

`Static`fromBinary

fromBinary(
bytes: Uint8Array,
options?: Partial<BinaryReadOptions>,
): navigationApi.Path
Parameters
- bytes: Uint8Array
- Optionaloptions: Partial<BinaryReadOptions>
Returns navigationApi.Path

`Static`fromJson

fromJson(
jsonValue: JsonValue,
options?: Partial<JsonReadOptions>,
): navigationApi.Path
Parameters
- jsonValue: JsonValue
- Optionaloptions: Partial<JsonReadOptions>
Returns navigationApi.Path

`Static`fromJsonString

fromJsonString(
jsonString: string,
options?: Partial<JsonReadOptions>,
): navigationApi.Path
Parameters
- jsonString: string
- Optionaloptions: Partial<JsonReadOptions>
Returns navigationApi.Path

Class Path

Generated

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns navigationApi.Path

Properties

destinationWaypointId

Generated

geopoints

Generated

Static Readonlyfields

Static Readonlyruntime

Static ReadonlytypeName

Methods

clone

Returns navigationApi.Path

equals

Parameters

Returns boolean

fromBinary

Parameters

Returns this

fromJson

Parameters

Returns this

fromJsonString

Parameters

Returns this

getType

Returns MessageType<navigationApi.Path>

toBinary

Parameters

Returns Uint8Array

toJson

Parameters

Returns JsonValue

ProtectedtoJSON

Returns JsonValue

toJsonString

Parameters

Returns string

Staticequals

Parameters

Returns boolean

StaticfromBinary

Parameters

Returns navigationApi.Path

StaticfromJson

Parameters

Returns navigationApi.Path

StaticfromJsonString

Parameters

Returns navigationApi.Path

Settings

On This Page

`Static` `Readonly`fields

`Static` `Readonly`runtime

`Static` `Readonly`typeName

`Protected`toJSON

`Static`equals

`Static`fromBinary

`Static`fromJson

`Static`fromJsonString