SMACC2
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
cl_lifecyclenode::CbCleanup Class Reference

#include <cb_cleanup.hpp>

Inheritance diagram for cl_lifecyclenode::CbCleanup:
Inheritance graph
Collaboration diagram for cl_lifecyclenode::CbCleanup:
Collaboration graph

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 ()
 
ISmaccStateMachinegetStateMachine ()
 
std::string getName () const
 
template<typename SmaccClientType >
void requiresClient (SmaccClientType *&storage)
 
template<typename SmaccComponentType >
void requiresComponent (SmaccComponentType *&storage, bool throwExceptionIfNotExist=false)
 
virtual void onExit ()
 

Private Attributes

ClLifecycleNodelifecycleNodeClient_
 

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 ()
 
ISmaccStategetCurrentState ()
 
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.

31{}

◆ ~CbCleanup()

virtual cl_lifecyclenode::CbCleanup::~CbCleanup ( )
inlinevirtual

Definition at line 32 of file cb_cleanup.hpp.

32{}

Member Function Documentation

◆ onEntry()

virtual void cl_lifecyclenode::CbCleanup::onEntry ( )
inlineoverridevirtual

Reimplemented from smacc2::ISmaccClientBehavior.

Definition at line 49 of file cb_cleanup.hpp.

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.

36 {
37 smacc2::SmaccAsyncClientBehavior::onOrthogonalAllocation<TOrthogonal, TSourceObject>();
38
40
42 { this->postSuccessEvent(); });
44 { this->postFailureEvent(); });
46 { this->postFailureEvent(); });
47 }
boost::signals2::signal< void()> onTransitionOnCleanupSuccess_
boost::signals2::signal< void()> onTransitionOnCleanupFailure_
boost::signals2::signal< void()> onTransitionOnCleanupError_
void requiresClient(SmaccClientType *&storage)

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: