Business Object (BO) class of GazeTargetStatus: the lifecycle of one gaze target request, as observed and published by the gaze scheduler. More...

#include <armarx/view_selection/gaze_targets/GazeTargetStatus.h>

Public Member Functions
bool	isTerminal () const
	Whether the target has left the scheduler's queue for good.

bool	wasReached () const
	Whether the gaze was fixed on this target at some point.

Public Attributes
armarx::DateTime	abortedTimestamp = armarx::DateTime::Invalid()

armarx::DateTime	activationTimestamp = armarx::DateTime::Invalid()

float	angularError = 0.F
	Angle between the gaze ray and the direction to the target at the transition [rad].

armarx::DateTime	creationTimestamp = armarx::DateTime::Invalid()

armarx::armem::MemoryID	gazeTargetID
	The gaze target request snapshot this status refers to.

float	lateralError = 0.F
	Lateral miss distance at target range at the transition [mm].

std::string	message
	Reason, for the terminal states. Empty otherwise.

armarx::DateTime	preemptedTimestamp = armarx::DateTime::Invalid()
	Most recent preemption, if any.

armarx::DateTime	reachedTimestamp = armarx::DateTime::Invalid()

armarx::DateTime	releasedTimestamp = armarx::DateTime::Invalid()

TargetStatus	status = TargetStatus::Requested

Detailed Description

Business Object (BO) class of GazeTargetStatus: the lifecycle of one gaze target request, as observed and published by the gaze scheduler.

A request (GazeTarget) is owned by whoever commits it; this status is owned by the scheduler and lives in its own core segment, keyed the same way. Every transition publishes a new snapshot carrying all timestamps accumulated so far, so the latest snapshot is the complete lifecycle and the snapshot history is the event stream.

Member Function Documentation

◆ isTerminal()

bool isTerminal ( ) const

Whether the target has left the scheduler's queue for good.

◆ wasReached()

bool wasReached ( ) const

Whether the gaze was fixed on this target at some point.

This is the success criterion, not status == Reached: a target that was reached and then superseded reports Released, and a client that only sees that last snapshot must still consider its request fulfilled.