viam.proto.component.posetracker

@generated by Viam. Do not edit manually!

Classes

`PoseTrackerServiceBase`	Helper class that provides a standard way to create an ABC using
`PoseTrackerServiceStub`
`UnimplementedPoseTrackerServiceBase`	Helper class that provides a standard way to create an ABC using
`GetPosesRequest`	Abstract base class for protocol messages.
`GetPosesResponse`	Abstract base class for protocol messages.

Package Contents

class viam.proto.component.posetracker.PoseTrackerServiceBase[source]

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstract GetPoses(stream: grpclib.server.Stream[component.posetracker.v1.pose_tracker_pb2.GetPosesRequest, component.posetracker.v1.pose_tracker_pb2.GetPosesResponse]) → None[source]

Async:

abstract DoCommand(stream: grpclib.server.Stream[common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse]) → None[source]

Async:

abstract GetGeometries(stream: grpclib.server.Stream[common.v1.common_pb2.GetGeometriesRequest, common.v1.common_pb2.GetGeometriesResponse]) → None[source]

Async:

__mapping__() → Dict[str, grpclib.const.Handler][source]

class viam.proto.component.posetracker.PoseTrackerServiceStub(channel: grpclib.client.Channel)[source]

GetPoses

DoCommand

GetGeometries

class viam.proto.component.posetracker.UnimplementedPoseTrackerServiceBase[source]

Bases: PoseTrackerServiceBase

Helper class that provides a standard way to create an ABC using inheritance.

async GetPoses(stream: grpclib.server.Stream[component.posetracker.v1.pose_tracker_pb2.GetPosesRequest, component.posetracker.v1.pose_tracker_pb2.GetPosesResponse]) → None[source]

async DoCommand(stream: grpclib.server.Stream[common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse]) → None[source]

async GetGeometries(stream: grpclib.server.Stream[common.v1.common_pb2.GetGeometriesRequest, common.v1.common_pb2.GetGeometriesResponse]) → None[source]

class viam.proto.component.posetracker.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.

name: str: Name of the pose tracker

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

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.

class viam.proto.component.posetracker.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.

key: str

property value: viam.gen.common.v1.common_pb2.PoseInFrame

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.