cl_ros2_timer::CbTimerCountdownOnce Class Reference

#include <cb_timer_countdown_once.hpp>

Inheritance diagram for cl_ros2_timer::CbTimerCountdownOnce:

Collaboration diagram for cl_ros2_timer::CbTimerCountdownOnce:

Public Member Functions
	CbTimerCountdownOnce (rclcpp::Duration targetDuration)
template<typename T , std::enable_if_t< std::is_integral< T >::value, int > = 0>
	CbTimerCountdownOnce (T)
void	onEntry () override
void	onExit () override
template<typename TOrthogonal , typename TSourceObject >
void	onStateOrthogonalAllocation ()
template<typename T >
smacc2::SmaccSignalConnection	onTimerTick (void(T::*callback)(), T *object)
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
rclcpp::Duration	targetDuration_
rclcpp::TimerBase::SharedPtr	wallTimer_
std::function< void()>	postCountDownEvent_
smacc2::SmaccSignal< void()>	onTimerTick_

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

Definition at line 22 of file cb_timer_countdown_once.hpp.

Constructor & Destructor Documentation

CbTimerCountdownOnce() [1/2]

cl_ros2_timer::CbTimerCountdownOnce::CbTimerCountdownOnce ( rclcpp::Duration targetDuration )

inline

Definition at line 25 of file cb_timer_countdown_once.hpp.

: targetDuration_(targetDuration) {}

CbTimerCountdownOnce() [2/2]

template<typename T , std::enable_if_t< std::is_integral< T >::value, int > = 0>

cl_ros2_timer::CbTimerCountdownOnce::CbTimerCountdownOnce ( T )

inlineexplicit

Definition at line 29 of file cb_timer_countdown_once.hpp.

  {
    static_assert(
      !std::is_integral<T>::value,
      "\n\nCbTimerCountdownOnce no longer accepts a tick count.\n"
      "Pass a chrono duration literal instead:\n"
      "  configure_orthogonal<OrTimer, CbTimerCountdownOnce>(5s);    // 5 seconds\n"
      "  configure_orthogonal<OrTimer, CbTimerCountdownOnce>(500ms); // 500 ms\n"
      "Migration guide: https://smacc2.robosoft.ai/how-to/how-to-cl-ros2-timer.html\n");
  }

Member Function Documentation

onEntry()

void cl_ros2_timer::CbTimerCountdownOnce::onEntry ( )

inlineoverridevirtual

Reimplemented from smacc2::ISmaccClientBehavior.

Definition at line 40 of file cb_timer_countdown_once.hpp.

  {
    auto node = this->getNode();
    auto clock = node->get_clock();
    wallTimer_ = rclcpp::create_timer(
      node, clock, std::chrono::nanoseconds(targetDuration_.nanoseconds()),
      [this]()
      {
        wallTimer_->cancel();
        onTimerTick_();
        postCountDownEvent_();
      });
  }

References smacc2::ISmaccClientBehavior::getNode(), targetDuration_, and wallTimer_.

Here is the call graph for this function:

onExit()

void cl_ros2_timer::CbTimerCountdownOnce::onExit ( )

inlineoverridevirtual

Reimplemented from smacc2::ISmaccClientBehavior.

Definition at line 54 of file cb_timer_countdown_once.hpp.

  {
    if (wallTimer_)
    {
      wallTimer_->cancel();
      wallTimer_.reset();
    }
  }

References wallTimer_.

onStateOrthogonalAllocation()

template<typename TOrthogonal , typename TSourceObject >

void cl_ros2_timer::CbTimerCountdownOnce::onStateOrthogonalAllocation ( )

inline

Definition at line 64 of file cb_timer_countdown_once.hpp.

  {
    this->postCountDownEvent_ = [=]()
    { this->template postEvent<EvTimer<TSourceObject, TOrthogonal>>(); };
  }

References postCountDownEvent_, and smacc2::ISmaccClientBehavior::postEvent().

Here is the call graph for this function:

onTimerTick()

template<typename T >

smacc2::SmaccSignalConnection cl_ros2_timer::CbTimerCountdownOnce::onTimerTick ( void(T::* callback )(), T * object )

inline

Definition at line 71 of file cb_timer_countdown_once.hpp.

  {
    return this->getStateMachine()->createSignalConnection(onTimerTick_, callback, object);
  }

References smacc2::ISmaccStateMachine::createSignalConnection(), smacc2::ISmaccClientBehavior::getStateMachine(), and onTimerTick_.

Here is the call graph for this function:

Member Data Documentation

onTimerTick_

smacc2::SmaccSignal<void()> cl_ros2_timer::CbTimerCountdownOnce::onTimerTick_

private

Definition at line 81 of file cb_timer_countdown_once.hpp.

Referenced by onTimerTick().

postCountDownEvent_

std::function<void()> cl_ros2_timer::CbTimerCountdownOnce::postCountDownEvent_

private

Definition at line 80 of file cb_timer_countdown_once.hpp.

Referenced by onStateOrthogonalAllocation().

targetDuration_

rclcpp::Duration cl_ros2_timer::CbTimerCountdownOnce::targetDuration_

private

Definition at line 77 of file cb_timer_countdown_once.hpp.

Referenced by onEntry().

wallTimer_

rclcpp::TimerBase::SharedPtr cl_ros2_timer::CbTimerCountdownOnce::wallTimer_

private

Definition at line 78 of file cb_timer_countdown_once.hpp.

Referenced by onEntry(), and onExit().

---

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

• smacc2_client_library/cl_ros2_timer/include/cl_ros2_timer/client_behaviors/cb_timer_countdown_once.hpp