yocs::Controller Class Reference

Controller template. More...

#include <default_controller.hpp>

Public Member Functions
	Controller ()
bool	disable ()
	Disables the controller. More...
bool	enable ()
	Enables the controller. More...
bool	getState ()
	Returns the current state of the controller. More...
virtual bool	init ()=0
	Initialise the controller. More...
virtual void	spin ()
	For complex controlling work. More...
virtual	~Controller ()

Private Attributes
bool	controller_active_

Detailed Description

Controller template.

Use this class for implementing various controllers.

Definition at line 57 of file default_controller.hpp.

Constructor & Destructor Documentation

yocs::Controller::Controller ( )

inline

Definition at line 60 of file default_controller.hpp.

virtual yocs::Controller::~Controller ( )

inlinevirtual

Definition at line 62 of file default_controller.hpp.

Member Function Documentation

bool yocs::Controller::disable ( )

inline

Disables the controller.

Returns

Returns true, if controller was active, false otherwise

Definition at line 95 of file default_controller.hpp.

bool yocs::Controller::enable ( )

inline

Enables the controller.

Returns

Returns true, if controller was inactive, false otherwise

Definition at line 77 of file default_controller.hpp.

bool yocs::Controller::getState ( )

inline

Returns the current state of the controller.

Returns

controller state variable

Definition at line 113 of file default_controller.hpp.

virtual bool yocs::Controller::init ( )

pure virtual

Initialise the controller.

Needs to be defined by any class inheriting from SafetyController

Returns

true, if initialisation was succcessful

virtual void yocs::Controller::spin ( )

inlinevirtual

For complex controlling work.

If needed, implement your complex algorithm here.

Definition at line 122 of file default_controller.hpp.

Member Data Documentation

bool yocs::Controller::controller_active_

private

Definition at line 125 of file default_controller.hpp.

---

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

• default_controller.hpp