#include <armarx/view_selection/client/ViewSelection.h>

Public Member Functions
armarx::armem::MemoryID	commitGazeTarget (const gaze_targets::GazeTarget &target)

GazeTargetWaiter::Result	commitGazeTargetAndWait (const gaze_targets::GazeTarget &target, const armarx::Duration &timeout, const std::function< bool()> &shouldAbort={})
	Commit a gaze target and block until the robot's gaze is fixed on it.

void	commitGazeTargets (const std::vector< gaze_targets::GazeTarget > &targets)

void	connect (StatusDelivery statusDelivery=StatusDelivery::Subscription)

std::optional< gaze_targets::GazeTarget >	readGazeTarget (const std::string &name)

std::optional< gaze_targets::GazeTargetStatus >	readGazeTargetStatus (const std::string &name)
	The lifecycle of the named target, as far as the scheduler has published it.

void	releaseGazeTarget (const gaze_targets::GazeTarget &target)
	Give up a target: lowest priority, no duration, not kept in the queue.

	ViewSelection (armarx::armem::client::MemoryNameSystem &mns, std::string providerSegmentName)

	~ViewSelection ()

Constructor & Destructor Documentation

◆ ViewSelection()

ViewSelection	(	armarx::armem::client::MemoryNameSystem &	mns,
		std::string	providerSegmentName )

~ViewSelection ( )

default

armem::MemoryID commitGazeTarget ( const gaze_targets::GazeTarget & target )

Returns: The memory ID of the committed request, invalid if the commit failed.

GazeTargetWaiter::Result commitGazeTargetAndWait	(	const gaze_targets::GazeTarget &	target,
		const armarx::Duration &	timeout,
		const std::function< bool()> &	shouldAbort = {} )

Commit a gaze target and block until the robot's gaze is fixed on it.

Arms the wait before committing, so a status update that arrives immediately is not missed.

Parameters

timeout	A non-positive duration waits indefinitely.
shouldAbort	Polled while waiting; typically a skill's shouldSkillTerminate().

void commitGazeTargets ( const std::vector< gaze_targets::GazeTarget > & targets )

void connect ( StatusDelivery statusDelivery = StatusDelivery::Subscription )

std::optional< gaze_targets::GazeTarget > readGazeTarget ( const std::string & name )

std::optional< gaze_targets::GazeTargetStatus > readGazeTargetStatus ( const std::string & name )

The lifecycle of the named target, as far as the scheduler has published it.

void releaseGazeTarget ( const gaze_targets::GazeTarget & target )

Give up a target: lowest priority, no duration, not kept in the queue.

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