cl_keyboard::ClKeyboard Class Reference

#include <cl_keyboard.hpp>

Inheritance diagram for cl_keyboard::ClKeyboard:

Collaboration diagram for cl_keyboard::ClKeyboard:

Public Member Functions
	ClKeyboard ()
virtual	~ClKeyboard ()
template<typename TOrthogonal , typename TClient >
void	onComponentInitialization ()
	ClKeyboard ()
virtual	~ClKeyboard ()
template<typename TOrthogonal , typename TClient >
void	onComponentInitialization ()
Public Member Functions inherited from smacc2::ISmaccClient
	ISmaccClient ()
virtual	~ISmaccClient ()
virtual void	onInitialize ()
virtual std::string	getName () const
template<typename TComponent >
TComponent *	getComponent ()
template<typename TComponent >
TComponent *	getComponent (std::string name)
template<typename TComponent >
TComponent *	getComponent (int index)
virtual smacc2::introspection::TypeInfo::Ptr	getType ()
ISmaccStateMachine *	getStateMachine ()
template<typename TSmaccSignal , typename T >
void	connectSignal (TSmaccSignal &signal, void(T::*callback)(), T *object)
template<typename SmaccClientType >
void	requiresClient (SmaccClientType *&storage)
void	getComponents (std::vector< std::shared_ptr< ISmaccComponent > > &components)
const std::vector< std::shared_ptr< ISmaccComponent > > &	iterateComponents () const
template<typename EventType >
void	postEvent (const EventType &ev)
template<typename EventType >
void	postEvent ()

Additional Inherited Members
Protected Member Functions inherited from smacc2::ISmaccClient
template<typename TOrthogonal , typename TClient >
void	onComponentInitialization ()
template<typename TOrthogonal , typename TSourceObject >
void	onOrthogonalAllocation ()
template<typename TOrthogonal , typename TSourceObject >
void	onStateOrthogonalAllocation ()
template<typename SmaccComponentType , typename TOrthogonal , typename TClient , typename... TArgs>
SmaccComponentType *	createComponent (TArgs... targs)
template<typename SmaccComponentType , typename TOrthogonal , typename TClient , typename... TArgs>
SmaccComponentType *	createNamedComponent (std::string name, TArgs... targs)
rclcpp::Node::SharedPtr	getNode ()
rclcpp::Logger	getLogger ()
Protected Attributes inherited from smacc2::ISmaccClient
std::map< ComponentKey, std::shared_ptr< smacc2::ISmaccComponent > >	components_

Detailed Description

Definition at line 32 of file cl_keyboard.hpp.

Constructor & Destructor Documentation

ClKeyboard() [1/2]

cl_keyboard::ClKeyboard::ClKeyboard

(

)

Definition at line 26 of file cl_keyboard.cpp.

{}

~ClKeyboard() [1/2]

cl_keyboard::ClKeyboard::~ClKeyboard ( )

virtual

Definition at line 28 of file cl_keyboard.cpp.

{}

ClKeyboard() [2/2]

cl_keyboard::ClKeyboard::ClKeyboard

(

)

~ClKeyboard() [2/2]

virtual cl_keyboard::ClKeyboard::~ClKeyboard ( )

virtual

Member Function Documentation

onComponentInitialization() [1/2]

template<typename TOrthogonal , typename TClient >

void cl_keyboard::ClKeyboard::onComponentInitialization ( )

inline

Definition at line 40 of file cl_keyboard.hpp.

  {
    // We start by creating a topic subscriber component from SMACC2s client core components.
    // We use this to gain the topic funcionality interated with SMACC and the ability to post smacc events for transitions.
    // We are using it to handle the reception of ros topic messages and to notify the other components in the client.
    this->createComponent<
      smacc2::client_core_components::CpTopicSubscriber<std_msgs::msg::UInt16>, TOrthogonal,
      ClKeyboard>("/keyboard_unicode");
 
    // This keyboard listener component requires CpTopicSubscriber.
    // It is notified by the CpTopicSubscriber and processes the messages to decide which keyboard event must be posted and then posts it.
    this->createComponent<cl_keyboard::components::CpKeyboardListener1, TOrthogonal, ClKeyboard>();
  }

References smacc2::ISmaccClient::createComponent().

Here is the call graph for this function:

onComponentInitialization() [2/2]

template<typename TOrthogonal , typename TClient >

void cl_keyboard::ClKeyboard::onComponentInitialization ( )

inline

Definition at line 40 of file cl_keyboard.hpp.

  {
    // We start by creating a topic subscriber component from SMACC2s client core components.
    // We use this to gain the topic funcionality interated with SMACC and the ability to post smacc events for transitions.
    // We are using it to handle the reception of ros topic messages and to notify the other components in the client.
    this->createComponent<
      smacc2::client_core_components::CpTopicSubscriber<std_msgs::msg::UInt16>, TOrthogonal,
      ClKeyboard>("/keyboard_unicode");
 
    // This keyboard listener component requires CpTopicSubscriber.
    // It is notified by the CpTopicSubscriber and processes the messages to decide which keyboard event must be posted and then posts it.
    this->createComponent<cl_keyboard::components::CpKeyboardListener1, TOrthogonal, ClKeyboard>();
  }

References smacc2::ISmaccClient::createComponent().

Here is the call graph for this function:

---

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

• smacc2_client_library/cl_keyboard/include/cl_keyboard/cl_keyboard.hpp
• smacc2_client_library/keyboard_client/include/keyboard_client/cl_keyboard.hpp
• smacc2_client_library/cl_keyboard/src/cl_keyboard/cl_keyboard.cpp
• smacc2_client_library/keyboard_client/src/keyboard_client/cl_keyboard.cpp