:py:mod:`viam.proto.component.posetracker`
==========================================

.. py:module:: viam.proto.component.posetracker

.. autoapi-nested-parse::

   @generated by Viam.
   Do not edit manually!



Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   viam.proto.component.posetracker.PoseTrackerServiceBase
   viam.proto.component.posetracker.PoseTrackerServiceStub
   viam.proto.component.posetracker.UnimplementedPoseTrackerServiceBase
   viam.proto.component.posetracker.GetPosesRequest
   viam.proto.component.posetracker.GetPosesResponse




.. py:class:: PoseTrackerServiceBase


   Bases: :py:obj:`abc.ABC`

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

   .. py:method:: GetPoses(stream: grpclib.server.Stream[component.posetracker.v1.pose_tracker_pb2.GetPosesRequest, component.posetracker.v1.pose_tracker_pb2.GetPosesResponse]) -> None
      :abstractmethod:
      :async:


   .. py:method:: DoCommand(stream: grpclib.server.Stream[common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse]) -> None
      :abstractmethod:
      :async:


   .. py:method:: GetGeometries(stream: grpclib.server.Stream[common.v1.common_pb2.GetGeometriesRequest, common.v1.common_pb2.GetGeometriesResponse]) -> None
      :abstractmethod:
      :async:


   .. py:method:: __mapping__() -> Dict[str, grpclib.const.Handler]



.. py:class:: PoseTrackerServiceStub(channel: grpclib.client.Channel)



.. py:class:: UnimplementedPoseTrackerServiceBase


   Bases: :py:obj:`PoseTrackerServiceBase`

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

   .. py:method:: GetPoses(stream: grpclib.server.Stream[component.posetracker.v1.pose_tracker_pb2.GetPosesRequest, component.posetracker.v1.pose_tracker_pb2.GetPosesResponse]) -> None
      :async:


   .. py:method:: DoCommand(stream: grpclib.server.Stream[common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse]) -> None
      :async:


   .. py:method:: GetGeometries(stream: grpclib.server.Stream[common.v1.common_pb2.GetGeometriesRequest, common.v1.common_pb2.GetGeometriesResponse]) -> None
      :async:



.. py:class:: GetPosesRequest(*, name: str = ..., body_names: collections.abc.Iterable[str] | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)


   Bases: :py:obj:`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.

   .. py:property:: body_names
      :type: 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

   .. py:property:: extra
      :type: google.protobuf.struct_pb2.Struct

      Additional arguments to the method

   .. py:attribute:: name
      :type: str

      Name of the pose tracker

   .. py: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, :exc:`ValueError` will
      be raised.

      :param field_name: The name of the field to check for presence.
      :type field_name: str

      :returns: Whether a value has been set for the named field.
      :rtype: bool

      :raises ValueError: if the `field_name` is not a member of this message.



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


   Bases: :py:obj:`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.

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


      Bases: :py:obj:`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.

      .. py:property:: value
         :type: viam.gen.common.v1.common_pb2.PoseInFrame


      .. py:attribute:: key
         :type: str

         

      .. py:method:: 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, :exc:`ValueError` will
         be raised.

         :param field_name: The name of the field to check for presence.
         :type field_name: str

         :returns: Whether a value has been set for the named field.
         :rtype: bool

         :raises ValueError: if the `field_name` is not a member of this message.



   .. py:property:: body_poses
      :type: 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.