src/movement/block_handler.h File Reference

The block handler component is responsible for executing blocks placed into the planning queue by the planner component. More...

#include <stdbool.h>

Go to the source code of this file.

Functions
void	block_handler_init (void)
	Initializes the block handler component.
void	block_handler_start (void)
	Starts the block handler thread.
void	block_handler_pause (void)
	Pauses the block handler thread.
void	block_handler_stop (void)
	Stops the block handler thread.
bool	block_handler_running (void)
	Returns whether the block handler thread is running.

---

Detailed Description

The block handler component is responsible for executing blocks placed into the planning queue by the planner component.

Author:

Pieter Agten (pieter.agten@gmail.com)

Date:

23 sep 2011

Definition in file block_handler.h.

---

Function Documentation

void block_handler_init

(

void

)

Initializes the block handler component.

Needs to be called only once, on boot. Note that this does not actually start the block handler thread.

See also:

block_handler_start

Definition at line 427 of file block_handler.c.

void block_handler_pause

(

void

)

Pauses the block handler thread.

This stops the block handler procedure from being executed, so no more steps will be taken until the thread is restarted. Note however that this will not cancel the current block. So the block handler thread will continue with the current block when it is restarted.

Definition at line 452 of file block_handler.c.

bool block_handler_running

(

void

)

Returns whether the block handler thread is running.

Returns:

Whether the block handler thread is running.

Definition at line 477 of file block_handler.c.

void block_handler_start

(

void

)

Starts the block handler thread.

Note that the block handler thread stops automatically when the planning queue is empty.

Definition at line 443 of file block_handler.c.

void block_handler_stop

(

void

)

Stops the block handler thread.

This stops the block handler procedure from being executed and cancels the current block. The block handler thread will continue with the next block in the planning queue when it is restarted.

Definition at line 463 of file block_handler.c.