Viam SDK
    Preparing search index...

    Class TrajectoryPoint

    One waypoint in a streamed joint-space trajectory.

    from message viam.component.arm.v1.TrajectoryPoint

    Hierarchy

    Index
    constructor
    constraints? positions? time? fields runtime typeName
    clone equals fromBinary fromJson fromJsonString getType toBinary toJson toJSON toJsonString equals fromBinary fromJson fromJsonString
    constraints?: TrajectoryPoint_KinematicConstraints

    Optional target kinematic constraints at this waypoint.

    from field: optional viam.component.arm.v1.TrajectoryPoint.KinematicConstraints constraints = 3;

    positions?: JointPositions

    Joint positions at this waypoint.

    from field: viam.component.arm.v1.JointPositions positions = 2;

    time?: Duration

    Time from the start of the motion at which this waypoint should be reached. Must be zero for the first point of the stream and strictly increasing thereafter. Server implementations should validate these constraints.

    from field: google.protobuf.Duration time = 1;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.component.arm.v1.TrajectoryPoint"

    • 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

    • Parse a message from a JSON value.

      Parameters

      • jsonValue: JsonValue
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Parse a message from a JSON string.

      Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

      Returns MessageType<TrajectoryPoint>

    • Serialize the message to binary data.

      Parameters

      • Optionaloptions: Partial<BinaryWriteOptions>

      Returns Uint8Array

    • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

      Parameters

      • Optionaloptions: Partial<JsonWriteOptions>

      Returns 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

    • Serialize the message to a JSON string.

      Parameters

      • Optionaloptions: Partial<JsonWriteStringOptions>

      Returns string

    • Parameters

      • bytes: Uint8Array
      • Optionaloptions: Partial<BinaryReadOptions>

      Returns TrajectoryPoint

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns TrajectoryPoint

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods