Sync behavior that forces an immediate agenda refresh. More...

#include <cb_refresh_agenda.hpp>

Inheritance diagram for cl_gcalcli::CbRefreshAgenda:

Collaboration diagram for cl_gcalcli::CbRefreshAgenda:

Public Member Functions
	CbRefreshAgenda ()=default

virtual	~CbRefreshAgenda ()=default

void	onEntry () override

bool	wasSuccessful () const
	Check if refresh was successful.

Public Member Functions inherited from smacc2::SmaccClientBehavior
virtual	~SmaccClientBehavior ()

void	onEntry () override

void	onExit () override

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)

virtual void	executeOnEntry ()

virtual void	executeOnExit ()

Private Attributes
ClGcalcli *	client_

bool	success_

Additional Inherited Members
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 void	dispose ()

virtual rclcpp::Node::SharedPtr	getNode () const

virtual rclcpp::Logger	getLogger () const

Detailed Description

Sync behavior that forces an immediate agenda refresh.

This behavior triggers an immediate refresh of the calendar agenda without waiting for the next poll interval.

Definition at line 30 of file cb_refresh_agenda.hpp.

Constructor & Destructor Documentation

◆ CbRefreshAgenda()

cl_gcalcli::CbRefreshAgenda::CbRefreshAgenda ( )

default

◆ ~CbRefreshAgenda()

virtual cl_gcalcli::CbRefreshAgenda::~CbRefreshAgenda ( )

virtualdefault

Member Function Documentation

◆ onEntry()

void cl_gcalcli::CbRefreshAgenda::onEntry ( )

overridevirtual

Reimplemented from smacc2::ISmaccClientBehavior.

Definition at line 20 of file cb_refresh_agenda.cpp.

{
  RCLCPP_INFO(getLogger(), "[CbRefreshAgenda] Refreshing calendar agenda");
 
  success_ = false;
 
  this->requiresClient(client_);
 
  if (!client_)
  {
    RCLCPP_ERROR(getLogger(), "[CbRefreshAgenda] ClGcalcli client not available");
    return;
  }
 
  auto * poller = client_->getPoller();
  if (!poller)
  {
    RCLCPP_ERROR(getLogger(), "[CbRefreshAgenda] CpCalendarPoller not available");
    return;
  }
 
  success_ = poller->refreshAgenda();
 
  if (success_)
  {
    auto events = poller->getEvents();
    RCLCPP_INFO(getLogger(), "[CbRefreshAgenda] Agenda refreshed: %zu events", events.size());
  }
  else
  {
    RCLCPP_WARN(getLogger(), "[CbRefreshAgenda] Agenda refresh failed");
  }
}

References client_, smacc2::ISmaccClientBehavior::getLogger(), cl_gcalcli::ClGcalcli::getPoller(), smacc2::ISmaccClientBehavior::requiresClient(), and success_.

Here is the call graph for this function:

◆ wasSuccessful()

bool cl_gcalcli::CbRefreshAgenda::wasSuccessful ( ) const

inline

Check if refresh was successful.

Definition at line 41 of file cb_refresh_agenda.hpp.

41{ return success_; }

References success_.

Member Data Documentation

◆ client_

ClGcalcli* cl_gcalcli::CbRefreshAgenda::client_

private

Definition at line 44 of file cb_refresh_agenda.hpp.

Referenced by onEntry().

◆ success_

bool cl_gcalcli::CbRefreshAgenda::success_

private

Definition at line 45 of file cb_refresh_agenda.hpp.

Referenced by onEntry(), and wasSuccessful().

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

smacc2_client_library/cl_gcalcli/include/cl_gcalcli/client_behaviors/cb_refresh_agenda.hpp
smacc2_client_library/cl_gcalcli/src/cl_gcalcli/client_behaviors/cb_refresh_agenda.cpp

Public Member Functions

Private Attributes

Additional Inherited Members