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.
Definition at line 23 of file GazeTargetStatus.h.
Member Function Documentation
◆ isTerminal()
| bool isTerminal | ( | ) | const |
Whether the target has left the scheduler's queue for good.
Definition at line 17 of file GazeTargetStatus.cpp.
Here is the call graph for this function:◆ 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.
Definition at line 11 of file GazeTargetStatus.cpp.
Member Data Documentation
◆ abortedTimestamp
| armarx::DateTime abortedTimestamp = armarx::DateTime::Invalid() |
Definition at line 43 of file GazeTargetStatus.h.
◆ activationTimestamp
| armarx::DateTime activationTimestamp = armarx::DateTime::Invalid() |
Definition at line 34 of file GazeTargetStatus.h.
◆ angularError
| float angularError = 0.F |
Angle between the gaze ray and the direction to the target at the transition [rad].
Definition at line 46 of file GazeTargetStatus.h.
◆ creationTimestamp
| armarx::DateTime creationTimestamp = armarx::DateTime::Invalid() |
Definition at line 32 of file GazeTargetStatus.h.
◆ gazeTargetID
| armarx::armem::MemoryID gazeTargetID |
The gaze target request snapshot this status refers to.
Disambiguates concurrent targets that share an entity name.
Definition at line 28 of file GazeTargetStatus.h.
◆ lateralError
| float lateralError = 0.F |
Lateral miss distance at target range at the transition [mm].
Definition at line 49 of file GazeTargetStatus.h.
◆ message
| std::string message |
Reason, for the terminal states. Empty otherwise.
Definition at line 52 of file GazeTargetStatus.h.
◆ preemptedTimestamp
| armarx::DateTime preemptedTimestamp = armarx::DateTime::Invalid() |
Most recent preemption, if any.
Definition at line 39 of file GazeTargetStatus.h.
◆ reachedTimestamp
| armarx::DateTime reachedTimestamp = armarx::DateTime::Invalid() |
Definition at line 36 of file GazeTargetStatus.h.
◆ releasedTimestamp
| armarx::DateTime releasedTimestamp = armarx::DateTime::Invalid() |
Definition at line 41 of file GazeTargetStatus.h.
◆ status
Definition at line 30 of file GazeTargetStatus.h.
The documentation for this class was generated from the following files:
- armarx/view_selection/gaze_targets/GazeTargetStatus.h
- armarx/view_selection/gaze_targets/GazeTargetStatus.cpp
