cl_lifecycle_node::CbActivate Class Reference

#include <cb_activate.hpp>

Inheritance diagram for cl_lifecycle_node::CbActivate:

Collaboration diagram for cl_lifecycle_node::CbActivate:

Public Member Functions
	CbActivate ()
virtual	~CbActivate ()
template<typename TOrthogonal , typename TSourceObject >
void	onStateOrthogonalAllocation ()
virtual void	onEntry () override
Public Member Functions inherited from smacc2::SmaccAsyncClientBehavior
template<typename TOrthogonal , typename TSourceObject >
void	onStateOrthogonalAllocation ()
virtual	~SmaccAsyncClientBehavior ()
template<typename TCallback , typename T >
boost::signals2::connection	onSuccess (TCallback callback, T *object)
template<typename TCallback , typename T >
boost::signals2::connection	onFinished (TCallback callback, T *object)
template<typename TCallback , typename T >
boost::signals2::connection	onFailure (TCallback callback, T *object)
void	requestForceFinish ()
void	executeOnEntry () override
void	executeOnExit () override
void	waitOnEntryThread (bool requestFinish)
template<typename TCallbackMethod , typename T >
boost::signals2::connection	onSuccess (TCallbackMethod callback, T *object)
template<typename TCallbackMethod , typename T >
boost::signals2::connection	onFinished (TCallbackMethod callback, T *object)
template<typename TCallbackMethod , typename T >
boost::signals2::connection	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)
virtual void	onExit ()

Private Attributes
ClLifecycleNode *	lifecycleNodeClient_
CpLifecycleEventMonitor *	eventMonitor_

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

Definition at line 29 of file cb_activate.hpp.

Constructor & Destructor Documentation

CbActivate()

cl_lifecycle_node::CbActivate::CbActivate ( )

inline

Definition at line 32 of file cb_activate.hpp.

{}

~CbActivate()

virtual cl_lifecycle_node::CbActivate::~CbActivate ( )

inlinevirtual

Definition at line 33 of file cb_activate.hpp.

{}

Member Function Documentation

onEntry()

virtual void cl_lifecycle_node::CbActivate::onEntry ( )

inlineoverridevirtual

Reimplemented from smacc2::ISmaccClientBehavior.

Definition at line 48 of file cb_activate.hpp.

{ lifecycleNodeClient_->activate(); }

References cl_lifecycle_node::ClLifecycleNode::activate(), and lifecycleNodeClient_.

Here is the call graph for this function:

onStateOrthogonalAllocation()

template<typename TOrthogonal , typename TSourceObject >

void cl_lifecycle_node::CbActivate::onStateOrthogonalAllocation ( )

inline

Definition at line 36 of file cb_activate.hpp.

  {
    smacc2::SmaccAsyncClientBehavior::onStateOrthogonalAllocation<TOrthogonal, TSourceObject>();
 
    this->requiresClient(lifecycleNodeClient_);
    this->requiresComponent(eventMonitor_);
 
    eventMonitor_->onTransitionOnActivateSuccess_.connect([this]() { this->postSuccessEvent(); });
    eventMonitor_->onTransitionOnActivateFailure_.connect([this]() { this->postFailureEvent(); });
    eventMonitor_->onTransitionOnActivateError_.connect([this]() { this->postFailureEvent(); });
  }

References eventMonitor_, lifecycleNodeClient_, smacc2::SmaccAsyncClientBehavior::onStateOrthogonalAllocation(), cl_lifecycle_node::CpLifecycleEventMonitor::onTransitionOnActivateError_, cl_lifecycle_node::CpLifecycleEventMonitor::onTransitionOnActivateFailure_, cl_lifecycle_node::CpLifecycleEventMonitor::onTransitionOnActivateSuccess_, smacc2::SmaccAsyncClientBehavior::postFailureEvent(), smacc2::SmaccAsyncClientBehavior::postSuccessEvent(), smacc2::ISmaccClientBehavior::requiresClient(), and smacc2::ISmaccClientBehavior::requiresComponent().

Here is the call graph for this function:

Member Data Documentation

eventMonitor_

CpLifecycleEventMonitor* cl_lifecycle_node::CbActivate::eventMonitor_

private

Definition at line 52 of file cb_activate.hpp.

Referenced by onStateOrthogonalAllocation().

lifecycleNodeClient_

ClLifecycleNode* cl_lifecycle_node::CbActivate::lifecycleNodeClient_

private

Definition at line 51 of file cb_activate.hpp.

Referenced by onEntry(), and onStateOrthogonalAllocation().

---

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

• smacc2_client_library/cl_lifecycle_node/include/cl_lifecycle_node/client_behaviors/cb_activate.hpp