cl_gcalcli::CbDetectCalendarEvent Class Reference

Async behavior that waits for a calendar event's start time to arrive. More...

#include <cb_detect_calendar_event.hpp>

Inheritance diagram for cl_gcalcli::CbDetectCalendarEvent:

Collaboration diagram for cl_gcalcli::CbDetectCalendarEvent:

Public Member Functions
	CbDetectCalendarEvent (const std::string &pattern, bool use_regex=false, int minutes_before=0)
	Construct with pattern configuration.
virtual	~CbDetectCalendarEvent ()=default
void	onEntry () override
void	onExit () override
std::optional< CalendarEvent >	getDetectedEvent () const
	Get the detected event (if any)
Public Member Functions inherited from smacc2::SmaccAsyncClientBehavior
template<typename TOrthogonal , typename TSourceObject >
void	onStateOrthogonalAllocation ()
virtual	~SmaccAsyncClientBehavior ()
template<typename TCallback , typename T >
smacc2::SmaccSignalConnection	onSuccess (TCallback callback, T *object)
template<typename TCallback , typename T >
smacc2::SmaccSignalConnection	onFinished (TCallback callback, T *object)
template<typename TCallback , typename T >
smacc2::SmaccSignalConnection	onFailure (TCallback callback, T *object)
void	requestForceFinish ()
void	executeOnEntry () override
void	executeOnExit () override
void	waitOnEntryThread (bool requestFinish)
template<typename TCallbackMethod , typename T >
smacc2::SmaccSignalConnection	onSuccess (TCallbackMethod callback, T *object)
template<typename TCallbackMethod , typename T >
smacc2::SmaccSignalConnection	onFinished (TCallbackMethod callback, T *object)
template<typename TCallbackMethod , typename T >
smacc2::SmaccSignalConnection	onFailure (TCallbackMethod callback, T *object)
Public Member Functions inherited from smacc2::ISmaccClientBehavior
	ISmaccClientBehavior ()
virtual	~ISmaccClientBehavior ()
ISmaccStateMachine *	getStateMachine ()
std::string	getName () const
template<typename SmaccClientType >
void	requiresClient (SmaccClientType *&storage)
template<typename SmaccComponentType >
void	requiresComponent (SmaccComponentType *&storage, ComponentRequirement requirementType=ComponentRequirement::SOFT)

Private Member Functions
void	onEventStarted (const CalendarEvent &event)
	Callback when an event starts.

Private Attributes
std::string	pattern_
bool	use_regex_
int	minutes_before_
CpCalendarEventListener *	listener_
ClGcalcli *	client_
std::optional< CalendarEvent >	detected_event_
bool	triggered_

Additional Inherited Members
Protected Member Functions inherited from smacc2::SmaccAsyncClientBehavior
void	postSuccessEvent ()
void	postFailureEvent ()
virtual void	dispose () override
bool	isShutdownRequested ()
	onEntry is executed in a new thread. However the current state cannot be left until the onEntry thread finishes. This flag can be checked from the onEntry thread to force finishing the thread.
Protected Member Functions inherited from smacc2::ISmaccClientBehavior
virtual void	runtimeConfigure ()
template<typename EventType >
void	postEvent (const EventType &ev)
template<typename EventType >
void	postEvent ()
ISmaccState *	getCurrentState ()
virtual rclcpp::Node::SharedPtr	getNode () const
virtual rclcpp::Logger	getLogger () const

Detailed Description

Async behavior that waits for a calendar event's start time to arrive.

This behavior configures a watch pattern on the CpCalendarEventListener and waits for an event matching the pattern to start. When the event start time arrives (minus minutes_before), it posts EvCbSuccess.

Usage in state:

static void staticConfigure() {
  // Wait for "Standup" events, trigger 5 minutes before start
  configure<OrCalendar, CbDetectCalendarEvent>(".*Standup.*", true, 5);
}

Definition at line 43 of file cb_detect_calendar_event.hpp.

Constructor & Destructor Documentation

CbDetectCalendarEvent()

cl_gcalcli::CbDetectCalendarEvent::CbDetectCalendarEvent	(	const std::string &	pattern,
		bool	use_regex = false,
		int	minutes_before = 0 )

Construct with pattern configuration.

Parameters

pattern	Pattern to match event titles
use_regex	If true, use regex matching; if false, substring match
minutes_before	Trigger N minutes before event starts (0 = at start)

Definition at line 24 of file cb_detect_calendar_event.cpp.

: pattern_(pattern),
  use_regex_(use_regex),
  minutes_before_(minutes_before),
  listener_(nullptr),
  client_(nullptr),
  triggered_(false)
{
}

~CbDetectCalendarEvent()

virtual cl_gcalcli::CbDetectCalendarEvent::~CbDetectCalendarEvent ( )

virtualdefault

Member Function Documentation

getDetectedEvent()

std::optional< CalendarEvent > cl_gcalcli::CbDetectCalendarEvent::getDetectedEvent ( ) const

inline

Get the detected event (if any)

Definition at line 63 of file cb_detect_calendar_event.hpp.

{ return detected_event_; }

References detected_event_.

onEntry()

void cl_gcalcli::CbDetectCalendarEvent::onEntry ( )

overridevirtual

Reimplemented from smacc2::ISmaccClientBehavior.

Definition at line 35 of file cb_detect_calendar_event.cpp.

{
  RCLCPP_INFO(
    getLogger(),
    "[CbDetectCalendarEvent] Waiting for event matching pattern '%s' (regex=%s, minutes_before=%d)",
    pattern_.c_str(), use_regex_ ? "true" : "false", minutes_before_);
 
  // Get the client and listener component
  this->requiresClient(client_);
  if (client_)
  {
    listener_ = client_->getEventListener();
  }
 
  if (!listener_)
  {
    RCLCPP_ERROR(getLogger(), "[CbDetectCalendarEvent] CpCalendarEventListener not available");
    this->postFailureEvent();
    return;
  }
 
  // Reset triggered events to allow re-detection
  listener_->resetTriggeredEvents();
 
  // Configure the watch
  EventWatch watch;
  watch.pattern = pattern_;
  watch.use_regex = use_regex_;
  watch.minutes_before = minutes_before_;
  watch.trigger_on_start = true;
  watch.trigger_on_end = false;
  watch.continuous = false;
 
  listener_->addWatch(watch);
 
  // Connect to the event started signal
  listener_->onEventStarted(&CbDetectCalendarEvent::onEventStarted, this);
}

References cl_gcalcli::CpCalendarEventListener::addWatch(), client_, cl_gcalcli::EventWatch::continuous, cl_gcalcli::ClGcalcli::getEventListener(), smacc2::ISmaccClientBehavior::getLogger(), listener_, cl_gcalcli::EventWatch::minutes_before, minutes_before_, onEventStarted(), cl_gcalcli::CpCalendarEventListener::onEventStarted(), cl_gcalcli::EventWatch::pattern, pattern_, smacc2::SmaccAsyncClientBehavior::postFailureEvent(), smacc2::ISmaccClientBehavior::requiresClient(), cl_gcalcli::CpCalendarEventListener::resetTriggeredEvents(), cl_gcalcli::EventWatch::trigger_on_end, cl_gcalcli::EventWatch::trigger_on_start, cl_gcalcli::EventWatch::use_regex, and use_regex_.

Here is the call graph for this function:

onEventStarted()

void cl_gcalcli::CbDetectCalendarEvent::onEventStarted ( const CalendarEvent & event )

private

Callback when an event starts.

Definition at line 79 of file cb_detect_calendar_event.cpp.

{
  if (triggered_)
  {
    return;  // Already triggered
  }
 
  // Check if this event matches our pattern
  bool matches = false;
  if (use_regex_)
  {
    try
    {
      boost::regex regex(pattern_, boost::regex::icase);
      matches = boost::regex_search(event.title, regex);
    }
    catch (const boost::regex_error &)
    {
      matches = false;
    }
  }
  else
  {
    std::string title_lower = event.title;
    std::string pattern_lower = pattern_;
    std::transform(title_lower.begin(), title_lower.end(), title_lower.begin(), ::tolower);
    std::transform(pattern_lower.begin(), pattern_lower.end(), pattern_lower.begin(), ::tolower);
    matches = title_lower.find(pattern_lower) != std::string::npos;
  }
 
  if (matches)
  {
    triggered_ = true;
    detected_event_ = event;
 
    RCLCPP_INFO(getLogger(), "[CbDetectCalendarEvent] Event detected: %s", event.title.c_str());
 
    this->postSuccessEvent();
  }
}

References detected_event_, smacc2::ISmaccClientBehavior::getLogger(), pattern_, smacc2::SmaccAsyncClientBehavior::postSuccessEvent(), cl_gcalcli::CalendarEvent::title, triggered_, and use_regex_.

Referenced by onEntry().

Here is the call graph for this function:

Here is the caller graph for this function:

onExit()

void cl_gcalcli::CbDetectCalendarEvent::onExit ( )

overridevirtual

Reimplemented from smacc2::ISmaccClientBehavior.

Definition at line 74 of file cb_detect_calendar_event.cpp.

{
  RCLCPP_DEBUG(getLogger(), "[CbDetectCalendarEvent] Exiting");
}

References smacc2::ISmaccClientBehavior::getLogger().

Here is the call graph for this function:

Member Data Documentation

client_

ClGcalcli* cl_gcalcli::CbDetectCalendarEvent::client_

private

Definition at line 76 of file cb_detect_calendar_event.hpp.

Referenced by onEntry().

detected_event_

std::optional<CalendarEvent> cl_gcalcli::CbDetectCalendarEvent::detected_event_

private

Definition at line 78 of file cb_detect_calendar_event.hpp.

Referenced by getDetectedEvent(), and onEventStarted().

listener_

CpCalendarEventListener* cl_gcalcli::CbDetectCalendarEvent::listener_

private

Definition at line 75 of file cb_detect_calendar_event.hpp.

Referenced by onEntry().

minutes_before_

int cl_gcalcli::CbDetectCalendarEvent::minutes_before_

private

Definition at line 73 of file cb_detect_calendar_event.hpp.

Referenced by onEntry().

pattern_

std::string cl_gcalcli::CbDetectCalendarEvent::pattern_

private

Definition at line 71 of file cb_detect_calendar_event.hpp.

Referenced by onEntry(), and onEventStarted().

triggered_

bool cl_gcalcli::CbDetectCalendarEvent::triggered_

private

Definition at line 79 of file cb_detect_calendar_event.hpp.

Referenced by onEventStarted().

use_regex_

bool cl_gcalcli::CbDetectCalendarEvent::use_regex_

private

Definition at line 72 of file cb_detect_calendar_event.hpp.

Referenced by onEntry(), and onEventStarted().

---

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

• smacc2_client_library/cl_gcalcli/include/cl_gcalcli/client_behaviors/cb_detect_calendar_event.hpp
• smacc2_client_library/cl_gcalcli/src/cl_gcalcli/client_behaviors/cb_detect_calendar_event.cpp