FibonacciState Class Reference

Represents the action state for the Fibonacci action. More...

Inheritance diagram for FibonacciState:

Collaboration diagram for FibonacciState:

Public Member Functions
	FibonacciState ()
	Constructs a new FibonacciState object and initializes callbacks.
Fibonacci::Goal	create_goal_handler (std::shared_ptr< yasmin::blackboard::Blackboard > blackboard)
	Callback for creating the Fibonacci action goal.
std::string	response_handler (std::shared_ptr< yasmin::blackboard::Blackboard > blackboard, Fibonacci::Result::SharedPtr response)
	Callback for handling the action response.
void	print_feedback (std::shared_ptr< yasmin::blackboard::Blackboard > blackboard, std::shared_ptr< const Fibonacci::Feedback > feedback)
	Callback for printing action feedback.
Public Member Functions inherited from yasmin_ros::ActionState< Fibonacci >
	ActionState (std::string action_name, CreateGoalHandler create_goal_handler, std::set< std::string > outcomes, int timeout=-1.0)
	Construct an ActionState with a specific action name and goal handler.
	ActionState (std::string action_name, CreateGoalHandler create_goal_handler, ResultHandler result_handler=nullptr, FeedbackHandler feedback_handler=nullptr, int timeout=-1.0)
	Construct an ActionState with result and feedback handlers.
	ActionState (std::string action_name, CreateGoalHandler create_goal_handler, std::set< std::string > outcomes, ResultHandler result_handler=nullptr, FeedbackHandler feedback_handler=nullptr, int timeout=-1.0)
	Construct an ActionState with outcomes and handlers.
	ActionState (const rclcpp::Node::SharedPtr &node, std::string action_name, CreateGoalHandler create_goal_handler, std::set< std::string > outcomes, ResultHandler result_handler=nullptr, FeedbackHandler feedback_handler=nullptr, int timeout=-1.0)
	Construct an ActionState with a specified node and action name.
void	cancel_state ()
	Cancel the current action state.
void	cancel_done ()
	Notify that the action cancellation has completed.
std::string	execute (std::shared_ptr< yasmin::blackboard::Blackboard > blackboard)
	Execute the action and return the outcome.
Public Member Functions inherited from yasmin::State
	State (std::set< std::string > outcomes)
	Constructs a State with a set of possible outcomes.
std::string	operator() (std::shared_ptr< blackboard::Blackboard > blackboard)
	Executes the state and returns the outcome.
bool	is_canceled () const
	Checks if the state has been canceled.
bool	is_running () const
	Checks if the state is currently running.
std::set< std::string > const &	get_outcomes ()
	Gets the set of possible outcomes for this state.
virtual std::string	to_string ()
	Converts the state to a string representation.

Additional Inherited Members
Protected Attributes inherited from yasmin::State
std::set< std::string >	outcomes
	The possible outcomes of this state.

Detailed Description

Represents the action state for the Fibonacci action.

This class manages goal creation, response handling, and feedback processing for the Fibonacci action.

Constructor & Destructor Documentation

FibonacciState()

FibonacciState::FibonacciState ( )

inline

Constructs a new FibonacciState object and initializes callbacks.

Member Function Documentation

create_goal_handler()

Fibonacci::Goal FibonacciState::create_goal_handler ( std::shared_ptr< yasmin::blackboard::Blackboard > blackboard )

inline

Callback for creating the Fibonacci action goal.

Reads the order of the Fibonacci sequence from the blackboard.

Parameters

blackboard

Shared pointer to the blackboard.

Returns

The Fibonacci goal with the specified order.

print_feedback()

void FibonacciState::print_feedback ( std::shared_ptr< yasmin::blackboard::Blackboard > blackboard, std::shared_ptr< const Fibonacci::Feedback > feedback )

inline

Callback for printing action feedback.

Displays each new partial Fibonacci sequence number as it is received.

Parameters

blackboard	Shared pointer to the blackboard (not used in this method).
feedback	Shared pointer to the feedback message with partial sequence.

response_handler()

std::string FibonacciState::response_handler ( std::shared_ptr< yasmin::blackboard::Blackboard > blackboard, Fibonacci::Result::SharedPtr response )

inline

Callback for handling the action response.

Stores the resulting Fibonacci sequence in the blackboard.

Parameters

blackboard	Shared pointer to the blackboard.
response	Shared pointer to the action result containing the sequence.

Returns

The outcome status indicating success.

---

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

• yasmin_demos/src/action_client_demo.cpp