viam.gen.component.posetracker.v1.pose_tracker_pb2

@generated by mypy-protobuf. Do not edit manually! isort:skip_file

Module Contents

Classes

GetPosesRequest

Abstract base class for protocol messages.

GetPosesResponse

Abstract base class for protocol messages.

Attributes

DESCRIPTOR

global___GetPosesRequest

global___GetPosesResponse

viam.gen.component.posetracker.v1.pose_tracker_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
class viam.gen.component.posetracker.v1.pose_tracker_pb2.GetPosesRequest(*, name: str = ..., body_names: collections.abc.Iterable[str] | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property body_names: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Names of the bodies whose poses are being requested. In the event this parameter is not supplied or is an empty list, all available poses are returned

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

name: str

Name of the pose tracker

HasField(field_name: Literal[extra, b'extra']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.component.posetracker.v1.pose_tracker_pb2.global___GetPosesRequest
class viam.gen.component.posetracker.v1.pose_tracker_pb2.GetPosesResponse(*, body_poses: collections.abc.Mapping[str, viam.gen.common.v1.common_pb2.PoseInFrame] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class BodyPosesEntry(*, key: str = ..., value: viam.gen.common.v1.common_pb2.PoseInFrame | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property value: viam.gen.common.v1.common_pb2.PoseInFrame
key: str
HasField(field_name: Literal[value, b'value']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

property body_poses: google.protobuf.internal.containers.MessageMap[str, viam.gen.common.v1.common_pb2.PoseInFrame]

Mapping of each body name to the pose representing the center of the body.

viam.gen.component.posetracker.v1.pose_tracker_pb2.global___GetPosesResponse