roboligo::ConnectorNode Class Reference

A lifecycle node that manages the robot connector. More...

#include <ConnectorNode.hpp>

Inheritance diagram for roboligo::ConnectorNode:

Collaboration diagram for roboligo::ConnectorNode:

Public Types
using	CallbackReturnT = rclcpp_lifecycle::node_interfaces::LifecycleNodeInterface::CallbackReturn

Public Member Functions
	ConnectorNode (const rclcpp::NodeOptions &options=rclcpp::NodeOptions())
	Constructor for ConnectorNode.
bool	cycle (std::shared_ptr< RobotState > robot_state)
	Method called cycle by cycle.
bool	init (std::shared_ptr< RobotState > robot_state)
	Method called when the node is initialize.
CallbackReturnT	on_activate (const rclcpp_lifecycle::State &state)
	Instructions on_activate state.
CallbackReturnT	on_cleanup (const rclcpp_lifecycle::State &state)
	Instructions on_cleanup state.
CallbackReturnT	on_configure (const rclcpp_lifecycle::State &state)
	Instructions on_configure state.
CallbackReturnT	on_deactivate (const rclcpp_lifecycle::State &state)
	Instructions on_deactivate state.
CallbackReturnT	on_error (const rclcpp_lifecycle::State &state)
	Instructions on_error state.
CallbackReturnT	on_shutdown (const rclcpp_lifecycle::State &state)
	Instructions on_shutdown state.
void	reset_connector (void)
	Method called when the node will be destroyed.
virtual	~ConnectorNode ()
	Destructor.

Detailed Description

A lifecycle node that manages the robot connector.

This class managments the connector working into roboligo

Member Typedef Documentation

CallbackReturnT

using roboligo::ConnectorNode::CallbackReturnT = rclcpp_lifecycle::node_interfaces::LifecycleNodeInterface::CallbackReturn

Constructor & Destructor Documentation

ConnectorNode()

roboligo::ConnectorNode::ConnectorNode ( const rclcpp::NodeOptions & options = rclcpp::NodeOptions() )

explicit

Constructor for ConnectorNode.

Parameters

NodeOptions

to configurate lifecycle node

~ConnectorNode()

roboligo::ConnectorNode::~ConnectorNode ( )

virtual

Destructor.

Member Function Documentation

cycle()

bool roboligo::ConnectorNode::cycle

(

std::shared_ptr< RobotState >

robot_state

)

Method called cycle by cycle.

Parameters

Robot

State object

Returns

bool success

init()

bool roboligo::ConnectorNode::init

(

std::shared_ptr< RobotState >

robot_state

)

Method called when the node is initialize.

Parameters

Robot

State object

Returns

bool success

on_activate()

CallbackReturnT roboligo::ConnectorNode::on_activate

(

const rclcpp_lifecycle::State &

state

)

Instructions on_activate state.

Parameters

state

lifecycle

Returns

CallbackReturnT defined in this class

on_cleanup()

CallbackReturnT roboligo::ConnectorNode::on_cleanup

(

const rclcpp_lifecycle::State &

state

)

Instructions on_cleanup state.

Parameters

state

lifecycle

Returns

CallbackReturnT defined in this class

on_configure()

CallbackReturnT roboligo::ConnectorNode::on_configure

(

const rclcpp_lifecycle::State &

state

)

Instructions on_configure state.

Parameters

state

lifecycle

Returns

CallbackReturnT defined in this class

on_deactivate()

CallbackReturnT roboligo::ConnectorNode::on_deactivate

(

const rclcpp_lifecycle::State &

state

)

Instructions on_deactivate state.

Parameters

state

lifecycle

Returns

CallbackReturnT defined in this class

on_error()

CallbackReturnT roboligo::ConnectorNode::on_error

(

const rclcpp_lifecycle::State &

state

)

Instructions on_error state.

Parameters

state

lifecycle

Returns

CallbackReturnT defined in this class

on_shutdown()

CallbackReturnT roboligo::ConnectorNode::on_shutdown

(

const rclcpp_lifecycle::State &

state

)

Instructions on_shutdown state.

Parameters

state

lifecycle

Returns

CallbackReturnT defined in this class

reset_connector()

void roboligo::ConnectorNode::reset_connector

(

void

)

Method called when the node will be destroyed.

---

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

• roboligo_connector/include/roboligo_connector/ConnectorNode.hpp
• roboligo_connector/src/roboligo_connector/ConnectorNode.cpp