ViewSelection Class Reference

#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 ()

Detailed Description

Definition at line 39 of file ViewSelection.h.

Constructor & Destructor Documentation

ViewSelection()

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

Definition at line 33 of file ViewSelection.cpp.

~ViewSelection()

~ViewSelection ( )

default

Member Function Documentation

commitGazeTarget()

armem::MemoryID commitGazeTarget

(

const gaze_targets::GazeTarget &

target

)

Returns

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

Definition at line 104 of file ViewSelection.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

commitGazeTargetAndWait()

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().

Definition at line 163 of file ViewSelection.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

commitGazeTargets()

void commitGazeTargets

(

const std::vector< gaze_targets::GazeTarget > &

targets

)

Definition at line 205 of file ViewSelection.cpp.

Here is the call graph for this function:

connect()

void connect

(

StatusDelivery

statusDelivery = StatusDelivery::Subscription

)

Definition at line 48 of file ViewSelection.cpp.

Here is the caller graph for this function:

readGazeTarget()

std::optional< gaze_targets::GazeTarget > readGazeTarget

(

const std::string &

name

)

Definition at line 81 of file ViewSelection.cpp.

Here is the call graph for this function:

readGazeTargetStatus()

std::optional< gaze_targets::GazeTargetStatus > readGazeTargetStatus

(

const std::string &

name

)

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

Definition at line 140 of file ViewSelection.cpp.

Here is the call graph for this function:

releaseGazeTarget()

void releaseGazeTarget

(

const gaze_targets::GazeTarget &

target

)

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

Definition at line 193 of file ViewSelection.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• armarx/view_selection/client/ViewSelection.h
• armarx/view_selection/client/ViewSelection.cpp