cl_nav2z::CbAbortNavigation Class Reference

#include <cb_abort_navigation.hpp>

Inheritance diagram for cl_nav2z::CbAbortNavigation:

Collaboration diagram for cl_nav2z::CbAbortNavigation:

Public Member Functions
	CbAbortNavigation ()
template<typename TOrthogonal , typename TSourceObject >
void	onStateOrthogonalAllocation ()
void	onEntry () override
void	onExit () override
	CbAbortNavigation ()
template<typename TOrthogonal , typename TSourceObject >
void	onStateOrthogonalAllocation ()
void	onEntry () override
void	onExit () override
Public Member Functions inherited from smacc2::SmaccAsyncClientBehavior
template<typename TOrthogonal , typename TSourceObject >
void	onOrthogonalAllocation ()
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, bool throwExceptionIfNotExist)
template<typename SmaccComponentType >
void	requiresComponent (SmaccComponentType *&storage, ComponentRequirement requirementType=ComponentRequirement::SOFT)

Private Attributes
components::CpNav2ActionInterface *	nav2ActionInterface_ = nullptr
cl_nav2z::ClNav2Z *	nav2zClient_

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 30 of file cb_abort_navigation.hpp.

Constructor & Destructor Documentation

CbAbortNavigation() [1/2]

cl_nav2z::CbAbortNavigation::CbAbortNavigation

(

)

Definition at line 32 of file cb_abort_navigation.cpp.

{}

CbAbortNavigation() [2/2]

cl_nav2z::CbAbortNavigation::CbAbortNavigation

(

)

Member Function Documentation

onEntry() [1/2]

void cl_nav2z::CbAbortNavigation::onEntry ( )

overridevirtual

Reimplemented from smacc2::ISmaccClientBehavior.

Definition at line 34 of file cb_abort_navigation.cpp.

{
  // this->sendGoal(goal);
 
  this->nav2ActionInterface_->cancelNavigation();
  this->postSuccessEvent();
}

References cl_nav2z::components::CpNav2ActionInterface::cancelNavigation(), nav2ActionInterface_, and smacc2::SmaccAsyncClientBehavior::postSuccessEvent().

Here is the call graph for this function:

onEntry() [2/2]

void cl_nav2z::CbAbortNavigation::onEntry ( )

overridevirtual

Reimplemented from smacc2::ISmaccClientBehavior.

onExit() [1/2]

void cl_nav2z::CbAbortNavigation::onExit ( )

overridevirtual

Reimplemented from smacc2::ISmaccClientBehavior.

Definition at line 42 of file cb_abort_navigation.cpp.

{}

onExit() [2/2]

void cl_nav2z::CbAbortNavigation::onExit ( )

overridevirtual

Reimplemented from smacc2::ISmaccClientBehavior.

onStateOrthogonalAllocation() [1/2]

template<typename TOrthogonal , typename TSourceObject >

void cl_nav2z::CbAbortNavigation::onStateOrthogonalAllocation ( )

inline

Definition at line 37 of file cb_abort_navigation.hpp.

  {
    this->requiresComponent(nav2ActionInterface_, ComponentRequirement::HARD);
    smacc2::SmaccAsyncClientBehavior::onStateOrthogonalAllocation<TOrthogonal, TSourceObject>();
  }

References nav2ActionInterface_, smacc2::SmaccAsyncClientBehavior::onStateOrthogonalAllocation(), and smacc2::ISmaccClientBehavior::requiresComponent().

Here is the call graph for this function:

onStateOrthogonalAllocation() [2/2]

template<typename TOrthogonal , typename TSourceObject >

void cl_nav2z::CbAbortNavigation::onStateOrthogonalAllocation ( )

inline

Definition at line 36 of file cb_abort_navigation.hpp.

  {
    this->requiresClient(nav2zClient_);
    smacc2::SmaccAsyncClientBehavior::onStateOrthogonalAllocation<TOrthogonal, TSourceObject>();
  }

References nav2zClient_, smacc2::SmaccAsyncClientBehavior::onStateOrthogonalAllocation(), and smacc2::ISmaccClientBehavior::requiresClient().

Here is the call graph for this function:

Member Data Documentation

nav2ActionInterface_

components::CpNav2ActionInterface* cl_nav2z::CbAbortNavigation::nav2ActionInterface_ = nullptr

private

Definition at line 47 of file cb_abort_navigation.hpp.

Referenced by onEntry(), and onStateOrthogonalAllocation().

nav2zClient_

cl_nav2z::ClNav2Z* cl_nav2z::CbAbortNavigation::nav2zClient_

private

Definition at line 46 of file cb_abort_navigation.hpp.

Referenced by onStateOrthogonalAllocation().

---

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

• smacc2_client_library/cl_nav2z/include/cl_nav2z/client_behaviors/cb_abort_navigation.hpp
• smacc2_client_library/nav2z_client/nav2z_client/include/nav2z_client/client_behaviors/cb_abort_navigation.hpp
• smacc2_client_library/cl_nav2z/src/cl_nav2z/client_behaviors/cb_abort_navigation.cpp
• smacc2_client_library/nav2z_client/nav2z_client/src/nav2z_client/client_behaviors/cb_abort_navigation.cpp