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 (int64_t triggerTickCount)
void	onEntry () override
void	onExit () override
template<typename TOrthogonal , typename TSourceObject >
void	onStateOrthogonalAllocation ()
template<typename T >
boost::signals2::connection	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, bool throwExceptionIfNotExist)
template<typename SmaccComponentType >
void	requiresComponent (SmaccComponentType *&storage, ComponentRequirement requirementType=ComponentRequirement::SOFT)
virtual void	executeOnEntry ()
virtual void	executeOnExit ()

Private Member Functions
void	onClientTimerTickCallback ()

Private Attributes
int64_t	tickCounter_
int64_t	tickTriggerCount_
ClRos2Timer *	timerClient_
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()

cl_ros2_timer::CbTimerCountdownOnce::CbTimerCountdownOnce ( int64_t triggerTickCount )

inline

Definition at line 25 of file cb_timer_countdown_once.hpp.

  : tickCounter_(0), tickTriggerCount_(triggerTickCount)
  {
  }

Member Function Documentation

onClientTimerTickCallback()

void cl_ros2_timer::CbTimerCountdownOnce::onClientTimerTickCallback ( )

inlineprivate

Definition at line 64 of file cb_timer_countdown_once.hpp.

  {
    tickCounter_++;
 
    if (tickCounter_ % tickTriggerCount_ == 0)
    {
      onTimerTick_();
      postCountDownEvent_();
    }
  }

References onTimerTick_, postCountDownEvent_, tickCounter_, and tickTriggerCount_.

Referenced by onEntry().

Here is the caller graph for this function:

onEntry()

void cl_ros2_timer::CbTimerCountdownOnce::onEntry ( )

inlineoverridevirtual

Reimplemented from smacc2::ISmaccClientBehavior.

Definition at line 30 of file cb_timer_countdown_once.hpp.

  {
    this->requiresClient(timerClient_);
 
    // Get the core timer component
    smacc2::client_core_components::CpRos2Timer * timerComponent;
    this->requiresComponent(timerComponent);
 
    // Connect to the core timer component
    timerComponent->onTimerTick(&CbTimerCountdownOnce::onClientTimerTickCallback, this);
  }

References onClientTimerTickCallback(), smacc2::client_core_components::CpRos2Timer::onTimerTick(), smacc2::ISmaccClientBehavior::requiresClient(), smacc2::ISmaccClientBehavior::requiresComponent(), and timerClient_.

Here is the call graph for this function:

onExit()

void cl_ros2_timer::CbTimerCountdownOnce::onExit ( )

inlineoverridevirtual

Reimplemented from smacc2::ISmaccClientBehavior.

Definition at line 42 of file cb_timer_countdown_once.hpp.

{}

onStateOrthogonalAllocation()

template<typename TOrthogonal , typename TSourceObject >

void cl_ros2_timer::CbTimerCountdownOnce::onStateOrthogonalAllocation ( )

inline

Definition at line 45 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 >

boost::signals2::connection cl_ros2_timer::CbTimerCountdownOnce::onTimerTick ( void(T::* callback )(), T * object )

inline

Definition at line 52 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 63 of file cb_timer_countdown_once.hpp.

Referenced by onClientTimerTickCallback(), and onTimerTick().

postCountDownEvent_

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

private

Definition at line 62 of file cb_timer_countdown_once.hpp.

Referenced by onClientTimerTickCallback(), and onStateOrthogonalAllocation().

tickCounter_

int64_t cl_ros2_timer::CbTimerCountdownOnce::tickCounter_

private

Definition at line 58 of file cb_timer_countdown_once.hpp.

Referenced by onClientTimerTickCallback().

tickTriggerCount_

int64_t cl_ros2_timer::CbTimerCountdownOnce::tickTriggerCount_

private

Definition at line 59 of file cb_timer_countdown_once.hpp.

Referenced by onClientTimerTickCallback().

timerClient_

ClRos2Timer* cl_ros2_timer::CbTimerCountdownOnce::timerClient_

private

Definition at line 61 of file cb_timer_countdown_once.hpp.

Referenced by onEntry().

---

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