Node Canopen Master Interface. More...
#include <node_canopen_master_interface.hpp>
Public Member Functions | |
| virtual void | init ()=0 |
| Initialise Master. More... | |
| virtual void | configure ()=0 |
| Configure the driver. More... | |
| virtual void | activate ()=0 |
| Activate the driver. More... | |
| virtual void | deactivate ()=0 |
| Deactivate the driver. More... | |
| virtual void | cleanup ()=0 |
| Cleanup the driver. More... | |
| virtual void | shutdown ()=0 |
| Shutdown the driver. More... | |
| virtual std::shared_ptr< lely::canopen::AsyncMaster > | get_master ()=0 |
| Get the master object. More... | |
| virtual std::shared_ptr< lely::ev::Executor > | get_executor ()=0 |
| Get the executor object. More... | |
Detailed Description
Node Canopen Master Interface.
This node provides the interface for NodeCanopenMaster classes that provide ROS node independent CANopen functionality.
Member Function Documentation
◆ init()
|
pure virtual |
Initialise Master.
Implemented in ros2_canopen::node_interfaces::NodeCanopenMaster< NODETYPE >.
◆ configure()
|
pure virtual |
Configure the driver.
This function should contain the configuration related things, such as reading parameter data or configuration data from files.
Implemented in ros2_canopen::node_interfaces::NodeCanopenMaster< NODETYPE >.
◆ activate()
|
pure virtual |
Activate the driver.
This function should activate the driver, consequently it needs to start all timers and threads necessary for the operation of the driver.
Implemented in ros2_canopen::node_interfaces::NodeCanopenMaster< NODETYPE >.
◆ deactivate()
|
pure virtual |
Deactivate the driver.
This function should deactivate the driver, consequently it needs to stop all timers and threads that are related to the operation of the diver.
Implemented in ros2_canopen::node_interfaces::NodeCanopenMaster< NODETYPE >.
◆ cleanup()
|
pure virtual |
Cleanup the driver.
This function needs to clean the internal state of the driver. This means all data should be deleted.
Implemented in ros2_canopen::node_interfaces::NodeCanopenMaster< NODETYPE >.
◆ shutdown()
|
pure virtual |
Shutdown the driver.
This function should shutdown the driver.
Implemented in ros2_canopen::node_interfaces::NodeCanopenMaster< NODETYPE >.
◆ get_master()
|
pure virtual |
Get the master object.
- Returns
- std::shared_ptr<lely::canopen::AsyncMaster>
Implemented in ros2_canopen::node_interfaces::NodeCanopenMaster< NODETYPE >.
◆ get_executor()
|
pure virtual |
Get the executor object.
- Returns
- std::shared_ptr<lely::canopen::Executor>
Implemented in ros2_canopen::node_interfaces::NodeCanopenMaster< NODETYPE >.
The documentation for this class was generated from the following file:
- /home/runner/work/ros2_canopen/ros2_canopen/canopen_core/include/canopen_core/node_interfaces/node_canopen_master_interface.hpp
