cl_nav2z::CpSlamToolbox Class Reference

#include <cp_slam_toolbox.hpp>

Inheritance diagram for cl_nav2z::CpSlamToolbox:

Collaboration diagram for cl_nav2z::CpSlamToolbox:

Public Types
enum class	SlamToolboxState { Resumed , Paused , Resumed , Paused }
enum class	SlamToolboxState { Resumed , Paused , Resumed , Paused }

Public Member Functions
	CpSlamToolbox ()
virtual	~CpSlamToolbox ()
SlamToolboxState	getState ()
void	toggleState ()
	CpSlamToolbox ()
virtual	~CpSlamToolbox ()
SlamToolboxState	getState ()
void	toggleState ()
Public Member Functions inherited from smacc2::ISmaccComponent
	ISmaccComponent ()
virtual	~ISmaccComponent ()
virtual std::string	getName () const

Private Attributes
SlamToolboxState	state_

Additional Inherited Members
Protected Member Functions inherited from smacc2::ISmaccComponent
virtual void	onInitialize ()
template<typename TOrthogonal , typename TClient >
void	onComponentInitialization ()
template<typename EventType >
void	postEvent (const EventType &ev)
template<typename EventType >
void	postEvent ()
template<typename TOrthogonal , typename TSourceObject >
void	onOrthogonalAllocation ()
template<typename TOrthogonal , typename TSourceObject >
void	onStateOrthogonalAllocation ()
template<typename TComponent >
void	requiresComponent (TComponent *&requiredComponentStorage, bool throwExceptionIfNotExist)
template<typename TComponent >
void	requiresComponent (std::string name, TComponent *&requiredComponentStorage, bool throwExceptionIfNotExist)
template<typename TComponent >
void	requiresComponent (TComponent *&requiredComponentStorage, ComponentRequirement requirementType=ComponentRequirement::SOFT)
template<typename TComponent >
void	requiresComponent (std::string name, TComponent *&requiredComponentStorage, ComponentRequirement requirementType=ComponentRequirement::SOFT)
template<typename TClient >
void	requiresClient (TClient *&requiredClientStorage)
template<typename SmaccComponentType , typename TOrthogonal , typename TClient , typename... TArgs>
SmaccComponentType *	createSiblingComponent (TArgs... targs)
template<typename SmaccComponentType , typename TOrthogonal , typename TClient , typename... TArgs>
SmaccComponentType *	createSiblingNamedComponent (std::string name, TArgs... targs)
rclcpp::Node::SharedPtr	getNode ()
rclcpp::Logger	getLogger () const
ISmaccStateMachine *	getStateMachine ()
Protected Attributes inherited from smacc2::ISmaccComponent
ISmaccStateMachine *	stateMachine_
ISmaccClient *	owner_

Detailed Description

Definition at line 31 of file cp_slam_toolbox.hpp.

Member Enumeration Documentation

SlamToolboxState [1/2]

enum class cl_nav2z::CpSlamToolbox::SlamToolboxState

strong

Enumerator
Resumed
Paused
Resumed
Paused

Definition at line 37 of file cp_slam_toolbox.hpp.

  {
    Resumed,
    Paused
  };

SlamToolboxState [2/2]

enum class cl_nav2z::CpSlamToolbox::SlamToolboxState

strong

Enumerator
Resumed
Paused
Resumed
Paused

Definition at line 37 of file cp_slam_toolbox.hpp.

  {
    Resumed,
    Paused
  };

Constructor & Destructor Documentation

CpSlamToolbox() [1/2]

cl_nav2z::CpSlamToolbox::CpSlamToolbox

(

)

Definition at line 25 of file cp_slam_toolbox.cpp.

: state_(SlamToolboxState::Resumed) {}

~CpSlamToolbox() [1/2]

cl_nav2z::CpSlamToolbox::~CpSlamToolbox ( )

virtual

Definition at line 26 of file cp_slam_toolbox.cpp.

{}

CpSlamToolbox() [2/2]

cl_nav2z::CpSlamToolbox::CpSlamToolbox

(

)

~CpSlamToolbox() [2/2]

virtual cl_nav2z::CpSlamToolbox::~CpSlamToolbox ( )

virtual

Member Function Documentation

getState() [1/2]

SlamToolboxState cl_nav2z::CpSlamToolbox::getState ( )

inline

Definition at line 43 of file cp_slam_toolbox.hpp.

{ return state_; }

References state_.

Referenced by cl_nav2z::CbPauseSlam::onEntry(), and cl_nav2z::CbResumeSlam::onEntry().

Here is the caller graph for this function:

getState() [2/2]

SlamToolboxState cl_nav2z::CpSlamToolbox::getState ( )

inline

Definition at line 43 of file cp_slam_toolbox.hpp.

{ return state_; }

References state_.

toggleState() [1/2]

void cl_nav2z::CpSlamToolbox::toggleState

(

)

Definition at line 28 of file cp_slam_toolbox.cpp.

{
  if (state_ == SlamToolboxState::Paused)
  {
    state_ = SlamToolboxState::Resumed;
  }
  else
  {
    state_ = SlamToolboxState::Paused;
  }
}

References Paused, Resumed, and state_.

Referenced by cl_nav2z::CbPauseSlam::onEntry(), and cl_nav2z::CbResumeSlam::onEntry().

Here is the caller graph for this function:

toggleState() [2/2]

void cl_nav2z::CpSlamToolbox::toggleState

(

)

Member Data Documentation

state_

SlamToolboxState cl_nav2z::CpSlamToolbox::state_

private

Definition at line 48 of file cp_slam_toolbox.hpp.

Referenced by getState(), and toggleState().

---

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

• smacc2_client_library/cl_nav2z/include/cl_nav2z/components/slam_toolbox/cp_slam_toolbox.hpp
• smacc2_client_library/nav2z_client/nav2z_client/include/nav2z_client/components/slam_toolbox/cp_slam_toolbox.hpp
• smacc2_client_library/cl_nav2z/src/cl_nav2z/components/slam_toolbox/cp_slam_toolbox.cpp
• smacc2_client_library/nav2z_client/nav2z_client/src/nav2z_client/components/slam_toolbox/cp_slam_toolbox.cpp