Skip to main content

AnnounceState Struct

The periodic announcement's state, held together so the guard's lifetime is the lifetime of what it guards. Shared, and captured into the timer by value the way RclcppSubscriberInterface does, so a callback the executor already dispatched cannot outlive this Behavior. More...

Declaration​

struct moveit_pro::behaviors::BreakpointSubscriber::AnnounceState { ... }

Public Member Attributes Index​

std::mutexguard

Held for the length of an announcement, and by the destructor. More...

std::atomic_boolactive { false }

Cleared once the breakpoint stops announcing, making an in-flight callback a no-op. More...

boolpublish_failing = false

Whether the last announcement failed, so a persistent failure is logged once rather than twice a second for the length of the pause. Only the timer callback touches it. More...

Description​

The periodic announcement's state, held together so the guard's lifetime is the lifetime of what it guards. Shared, and captured into the timer by value the way RclcppSubscriberInterface does, so a callback the executor already dispatched cannot outlive this Behavior.

Definition at line 191 of file breakpoint_subscriber.hpp.

Public Member Attributes​

active​

std::atomic_bool moveit_pro::behaviors::BreakpointSubscriber::AnnounceState::active { false }

Cleared once the breakpoint stops announcing, making an in-flight callback a no-op.

Definition at line 197 of file breakpoint_subscriber.hpp.

guard​

std::mutex moveit_pro::behaviors::BreakpointSubscriber::AnnounceState::guard

Held for the length of an announcement, and by the destructor.

Definition at line 194 of file breakpoint_subscriber.hpp.

publish_failing​

bool moveit_pro::behaviors::BreakpointSubscriber::AnnounceState::publish_failing = false

Whether the last announcement failed, so a persistent failure is logged once rather than twice a second for the length of the pause. Only the timer callback touches it.

Definition at line 203 of file breakpoint_subscriber.hpp.

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

Generated via doxygen2docusaurus 2.2.2 by Doxygen 1.9.8.