cl_lifecyclenode::CbCleanup Class Reference

#include <cb_cleanup.hpp>

Inheritance diagram for cl_lifecyclenode::CbCleanup:

Collaboration diagram for cl_lifecyclenode::CbCleanup:

Public Member Functions
	CbCleanup ()
virtual	~CbCleanup ()
template<typename TOrthogonal , typename TSourceObject >
void	onOrthogonalAllocation ()
virtual void	onEntry () override
Public Member Functions inherited from smacc2::SmaccAsyncClientBehavior
template<typename TOrthogonal , typename TSourceObject >
void	onOrthogonalAllocation ()
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, bool throwExceptionIfNotExist=false)
virtual void	onEntry ()
virtual void	onExit ()
virtual void	executeOnEntry ()
virtual void	executeOnExit ()

Private Attributes
ClLifecycleNode *	lifecycleNodeClient_

Additional Inherited Members
Protected Member Functions inherited from smacc2::SmaccAsyncClientBehavior
void	postSuccessEvent ()
void	postFailureEvent ()
virtual void	dispose () override
bool	isShutdownRequested ()
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 28 of file cb_cleanup.hpp.

Constructor & Destructor Documentation

CbCleanup()

cl_lifecyclenode::CbCleanup::CbCleanup ( )

inline

Definition at line 31 of file cb_cleanup.hpp.

{}

~CbCleanup()

virtual cl_lifecyclenode::CbCleanup::~CbCleanup ( )

inlinevirtual

Definition at line 32 of file cb_cleanup.hpp.

{}

Member Function Documentation

onEntry()

virtual void cl_lifecyclenode::CbCleanup::onEntry ( )

inlineoverridevirtual

Reimplemented from smacc2::ISmaccClientBehavior.

Definition at line 49 of file cb_cleanup.hpp.

{ lifecycleNodeClient_->cleanup(); }

References cl_lifecyclenode::ClLifecycleNode::cleanup(), and lifecycleNodeClient_.

Here is the call graph for this function:

onOrthogonalAllocation()

template<typename TOrthogonal , typename TSourceObject >

void cl_lifecyclenode::CbCleanup::onOrthogonalAllocation ( )

inline

Definition at line 35 of file cb_cleanup.hpp.

  {
    smacc2::SmaccAsyncClientBehavior::onOrthogonalAllocation<TOrthogonal, TSourceObject>();
 
    this->requiresClient(this->lifecycleNodeClient_);
 
    lifecycleNodeClient_->onTransitionOnCleanupSuccess_.connect([this]()
                                                                { this->postSuccessEvent(); });
    lifecycleNodeClient_->onTransitionOnCleanupFailure_.connect([this]()
                                                                { this->postFailureEvent(); });
    lifecycleNodeClient_->onTransitionOnCleanupError_.connect([this]()
                                                              { this->postFailureEvent(); });
  }

References lifecycleNodeClient_, cl_lifecyclenode::ClLifecycleNode::onTransitionOnCleanupError_, cl_lifecyclenode::ClLifecycleNode::onTransitionOnCleanupFailure_, cl_lifecyclenode::ClLifecycleNode::onTransitionOnCleanupSuccess_, smacc2::SmaccAsyncClientBehavior::postFailureEvent(), smacc2::SmaccAsyncClientBehavior::postSuccessEvent(), and smacc2::ISmaccClientBehavior::requiresClient().

Here is the call graph for this function:

Member Data Documentation

lifecycleNodeClient_

ClLifecycleNode* cl_lifecyclenode::CbCleanup::lifecycleNodeClient_

private

Definition at line 52 of file cb_cleanup.hpp.

Referenced by onEntry(), and onOrthogonalAllocation().

---

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

• smacc2_client_library/lifecyclenode_client/include/lifecyclenode_client/client_behaviors/cb_cleanup.hpp