roboligo::StatesNode Class Reference

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

#include <StatesNode.hpp>

Inheritance diagram for roboligo::StatesNode:

Collaboration diagram for roboligo::StatesNode:

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

Public Member Functions
bool	cycle (std::shared_ptr< RobotState > robot_state)
	Method used for each iteration.
bool	init (std::shared_ptr< RobotState > robot_state)
	Method called at initialize and configurate settings.
CallbackReturnT	on_activate (const rclcpp_lifecycle::State &state)
	Instructions on_active 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_classification (void)
	When the node is in shutdowning, this method is called.
	StatesNode (const rclcpp::NodeOptions &options=rclcpp::NodeOptions())
	Constructor for StatesNode.
	~StatesNode ()
	Destructor.

Detailed Description

A lifecycle node that manages the configuration robot.

This class managments the modes and triggers for each robot type

Member Typedef Documentation

CallbackReturnT

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

Constructor & Destructor Documentation

StatesNode()

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

explicit

Constructor for StatesNode.

Parameters

NodeOptions

to configurate lifecycle node

~StatesNode()

roboligo::StatesNode::~StatesNode

(

)

Destructor.

Member Function Documentation

cycle()

bool roboligo::StatesNode::cycle

(

std::shared_ptr< RobotState >

robot_state

)

Method used for each iteration.

Parameters

robot

state object

Returns

bool success result

init()

bool roboligo::StatesNode::init

(

std::shared_ptr< RobotState >

robot_state

)

Method called at initialize and configurate settings.

Parameters

robot

state object

Returns

bool success result

on_activate()

CallbackReturnT roboligo::StatesNode::on_activate

(

const rclcpp_lifecycle::State &

state

)

Instructions on_active state.

Parameters

state

lifecycle

Returns

CallbackReturnT defined in this class

on_cleanup()

CallbackReturnT roboligo::StatesNode::on_cleanup

(

const rclcpp_lifecycle::State &

state

)

Instructions on_cleanup state.

Parameters

state

lifecycle

Returns

CallbackReturnT defined in this class

on_configure()

CallbackReturnT roboligo::StatesNode::on_configure

(

const rclcpp_lifecycle::State &

state

)

Instructions on_configure state.

Parameters

state

lifecycle

Returns

CallbackReturnT defined in this class

on_deactivate()

CallbackReturnT roboligo::StatesNode::on_deactivate

(

const rclcpp_lifecycle::State &

state

)

Instructions on_deactivate state.

Parameters

state

lifecycle

Returns

CallbackReturnT defined in this class

on_error()

CallbackReturnT roboligo::StatesNode::on_error

(

const rclcpp_lifecycle::State &

state

)

Instructions on_error state.

Parameters

state

lifecycle

Returns

CallbackReturnT defined in this class

on_shutdown()

CallbackReturnT roboligo::StatesNode::on_shutdown

(

const rclcpp_lifecycle::State &

state

)

Instructions on_shutdown state.

Parameters

state

lifecycle

Returns

CallbackReturnT defined in this class

reset_classification()

void roboligo::StatesNode::reset_classification

(

void

)

When the node is in shutdowning, this method is called.

---

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

• roboligo_states/include/roboligo_states/StatesNode.hpp
• roboligo_states/src/roboligo_states/StatesNode.cpp