cl_ros_timer::CbTimerCountdownOnce Class Reference

#include <cb_timer_countdown_once.h>

Inheritance diagram for cl_ros_timer::CbTimerCountdownOnce:

Collaboration diagram for cl_ros_timer::CbTimerCountdownOnce:

Public Member Functions
	CbTimerCountdownOnce (uint64_t triggerTickCount)
virtual void	onEntry () override
virtual void	onExit () override
template<typename TOrthogonal , typename TSourceObject >
void	onOrthogonalAllocation ()
template<typename T >
boost::signals2::connection	onTimerTick (void(T::*callback)(), T *object)
virtual void	onEntry () override
virtual void	onExit () override
Public Member Functions inherited from smacc::ISmaccClientBehavior
	ISmaccClientBehavior ()
virtual	~ISmaccClientBehavior ()
ISmaccStateMachine *	getStateMachine ()
std::string	getName () const
template<typename SmaccClientType >
void	requiresClient (SmaccClientType *&storage)
template<typename SmaccComponentType >
void	requiresComponent (SmaccComponentType *&storage)
ros::NodeHandle	getNode ()

Private Member Functions
void	onClientTimerTickCallback ()

Private Attributes
uint64_t	tickCounter_
uint64_t	tickTriggerCount_
ClRosTimer *	timerClient_
std::function< void()>	postCountDownEvent_
smacc::SmaccSignal< void()>	onTimerTick_

Additional Inherited Members
Protected Member Functions inherited from smacc::ISmaccClientBehavior
virtual void	runtimeConfigure ()
virtual void	onEntry ()
virtual void	onExit ()
template<typename EventType >
void	postEvent (const EventType &ev)
template<typename EventType >
void	postEvent ()
ISmaccState *	getCurrentState ()
virtual void	executeOnEntry ()
virtual void	executeOnExit ()
virtual void	dispose ()

Detailed Description

Definition at line 8 of file cb_timer_countdown_once.h.

Constructor & Destructor Documentation

CbTimerCountdownOnce()

cl_ros_timer::CbTimerCountdownOnce::CbTimerCountdownOnce

(

uint64_t

triggerTickCount

)

Definition at line 6 of file cb_timer_countdown_once.cpp.

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

Member Function Documentation

onClientTimerTickCallback()

void cl_ros_timer::CbTimerCountdownOnce::onClientTimerTickCallback ( )

private

Definition at line 12 of file cb_timer_countdown_once.cpp.

{
    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_ros_timer::CbTimerCountdownOnce::onEntry ( )

overridevirtual

Reimplemented from smacc::SmaccClientBehavior.

Definition at line 23 of file cb_timer_countdown_once.cpp.

{
    this->requiresClient(timerClient_);
    timerClient_->onTimerTick(&CbTimerCountdownOnce::onClientTimerTickCallback, this);
}

References onClientTimerTickCallback(), cl_ros_timer::ClRosTimer::onTimerTick(), smacc::ISmaccClientBehavior::requiresClient(), and timerClient_.

Here is the call graph for this function:

onExit()

void cl_ros_timer::CbTimerCountdownOnce::onExit ( )

overridevirtual

Reimplemented from smacc::SmaccClientBehavior.

Definition at line 29 of file cb_timer_countdown_once.cpp.

{
}

onOrthogonalAllocation()

template<typename TOrthogonal , typename TSourceObject >

void cl_ros_timer::CbTimerCountdownOnce::onOrthogonalAllocation ( )

inline

Definition at line 17 of file cb_timer_countdown_once.h.

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

References postCountDownEvent_.

onTimerTick()

template<typename T >

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

inline

Definition at line 25 of file cb_timer_countdown_once.h.

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

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

Here is the call graph for this function:

Member Data Documentation

onTimerTick_

smacc::SmaccSignal<void()> cl_ros_timer::CbTimerCountdownOnce::onTimerTick_

private

Definition at line 36 of file cb_timer_countdown_once.h.

Referenced by onClientTimerTickCallback(), and onTimerTick().

postCountDownEvent_

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

private

Definition at line 35 of file cb_timer_countdown_once.h.

Referenced by onClientTimerTickCallback(), and onOrthogonalAllocation().

tickCounter_

uint64_t cl_ros_timer::CbTimerCountdownOnce::tickCounter_

private

Definition at line 31 of file cb_timer_countdown_once.h.

Referenced by onClientTimerTickCallback().

tickTriggerCount_

uint64_t cl_ros_timer::CbTimerCountdownOnce::tickTriggerCount_

private

Definition at line 32 of file cb_timer_countdown_once.h.

Referenced by onClientTimerTickCallback().

timerClient_

ClRosTimer* cl_ros_timer::CbTimerCountdownOnce::timerClient_

private

Definition at line 34 of file cb_timer_countdown_once.h.

Referenced by onEntry().

---

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

• smacc_client_library/ros_timer_client/include/ros_timer_client/client_behaviors/cb_timer_countdown_once.h
• smacc_client_library/ros_timer_client/src/ros_timer_client/cb_timer_countdown_once.cpp