viam::sdk::impl::PoseTrackerClient Class Reference

gRPC client implementation of a PoseTracker component. More...

#include <pose_tracker_client.hpp>

Inheritance diagram for viam::sdk::impl::PoseTrackerClient:

Public Types
using	interface_type = PoseTracker
Public Types inherited from viam::sdk::PoseTracker
using	pose_map = std::unordered_map<std::string, pose_in_frame>

Public Member Functions
	PoseTrackerClient (std::string name, const ViamChannel &channel)
const ViamChannel &	channel () const
PoseTracker::pose_map	get_poses (const std::vector< std::string > &body_names, const ProtoStruct &extra) override
	Get the poses of each body tracked by the pose tracker.
ProtoStruct	do_command (const ProtoStruct &command) override
	Send/receive arbitrary commands to the resource.
ProtoStruct	get_status () override
	Get the status of the pose tracker.
std::vector< GeometryConfig >	get_geometries (const ProtoStruct &extra) override
	Returns GeometryConfigs associated with the calling pose tracker.
std::vector< GeometryConfig >	get_geometries ()
	Returns GeometryConfigs associated with the calling pose tracker.
virtual std::vector< GeometryConfig >	get_geometries (const ProtoStruct &extra)=0
	Returns GeometryConfigs associated with the calling pose tracker.
pose_map	get_poses (const std::vector< std::string > &body_names)
	Get the poses of each body tracked by the pose tracker.
virtual pose_map	get_poses (const std::vector< std::string > &body_names, const ProtoStruct &extra)=0
	Get the poses of each body tracked by the pose tracker.
Public Member Functions inherited from viam::sdk::PoseTracker
API	api () const override
	Returns the API associated with a particular resource.
pose_map	get_poses (const std::vector< std::string > &body_names)
	Get the poses of each body tracked by the pose tracker.
std::vector< GeometryConfig >	get_geometries ()
	Returns GeometryConfigs associated with the calling pose tracker.
Public Member Functions inherited from viam::sdk::Component
Name	get_resource_name () const override
	Returns the Name for a particular resource.
Public Member Functions inherited from viam::sdk::Resource
	Resource (std::string name)
	Resource (const ResourceConfig &cfg)
	Construct from a resource config. Use this overload to ensure Viam App log filtering works immediately during object construction.
virtual std::string	name () const
	Return the resource's name.
void	set_log_level (log_level) const
	Set the log level for log messages originating from this Resource.

Additional Inherited Members
Protected Member Functions inherited from viam::sdk::PoseTracker
	Component ()
	Component (std::string name)
	Component (const ResourceConfig &cfg)
Protected Member Functions inherited from viam::sdk::Component
	Component (std::string name)
	Component (const ResourceConfig &cfg)
Protected Member Functions inherited from viam::sdk::Resource
Name	get_resource_name (const std::string &type) const
Protected Attributes inherited from viam::sdk::Resource
LogSource	logger_

Detailed Description

gRPC client implementation of a PoseTracker component.

Member Function Documentation

do_command()

ProtoStruct viam::sdk::impl::PoseTrackerClient::do_command ( const ProtoStruct & command )

overridevirtual

Send/receive arbitrary commands to the resource.

Parameters

Command

the command to execute.

Returns

The result of the executed command.

Implements viam::sdk::PoseTracker.

get_geometries() [1/2]

std::vector< GeometryConfig > viam::sdk::impl::PoseTrackerClient::get_geometries ( const ProtoStruct & extra )

overridevirtual

Returns GeometryConfigs associated with the calling pose tracker.

Parameters

extra

Any additional arguments to the method

Implements viam::sdk::PoseTracker.

get_geometries() [2/2]

virtual std::vector< GeometryConfig > viam::sdk::PoseTracker::get_geometries ( const ProtoStruct & extra )

virtual

Returns GeometryConfigs associated with the calling pose tracker.

Parameters

extra

Any additional arguments to the method

Implements viam::sdk::PoseTracker.

get_poses() [1/3]

pose_map viam::sdk::PoseTracker::get_poses ( const std::vector< std::string > & body_names )

inline

Get the poses of each body tracked by the pose tracker.

Parameters

tracker_name	The name of the pose tracker.
body_names	Names of bodies whose poses are being requested. If the vector is empty then all available poses are returned.

Returns

A mapping of each body to its pose.

get_poses() [2/3]

PoseTracker::pose_map viam::sdk::impl::PoseTrackerClient::get_poses ( const std::vector< std::string > & body_names, const ProtoStruct & extra )

overridevirtual

Get the poses of each body tracked by the pose tracker.

Parameters

tracker_name	The name of the pose tracker.
body_names	Names of bodies whose poses are being requested. If the vector is empty then all available poses are returned.
extra	Any additional arguments to the method.

Returns

A mapping of each body to its pose.

Implements viam::sdk::PoseTracker.

get_poses() [3/3]

virtual pose_map viam::sdk::PoseTracker::get_poses ( const std::vector< std::string > & body_names, const ProtoStruct & extra )

virtual

Get the poses of each body tracked by the pose tracker.

Parameters

tracker_name	The name of the pose tracker.
body_names	Names of bodies whose poses are being requested. If the vector is empty then all available poses are returned.
extra	Any additional arguments to the method.

Returns

A mapping of each body to its pose.

Implements viam::sdk::PoseTracker.

get_status()

ProtoStruct viam::sdk::impl::PoseTrackerClient::get_status ( )

overridevirtual

Get the status of the pose tracker.

Returns

A ProtoStruct containing the status of the pose tracker.

Implements viam::sdk::PoseTracker.

---

The documentation for this class was generated from the following file:

• src/viam/sdk/components/private/pose_tracker_client.hpp