Public Member Functions | Private Attributes
yocs::Controller Class Reference

Controller template. More...

#include <default_controller.hpp>

List of all members.

Public Member Functions

 Controller ()
bool disable ()
 Disables the controller.
bool enable ()
 Enables the controller.
bool getState ()
 Returns the current state of the controller.
virtual bool init ()=0
 Initialise the controller.
virtual void spin ()
 For complex controlling work.
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

Definition at line 60 of file default_controller.hpp.

virtual yocs::Controller::~Controller ( ) [inline, virtual]

Definition at line 62 of file default_controller.hpp.

Member Function Documentation

bool yocs::Controller::disable ( ) [inline]

Disables the controller.

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 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.

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

true, if initialisation was succcessful
virtual void yocs::Controller::spin ( ) [inline, virtual]

For complex controlling work.

If needed, implement your complex algorithm here.

Definition at line 122 of file default_controller.hpp.

Member Data Documentation

Definition at line 125 of file default_controller.hpp.

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

Author(s): Marcus Liebhardt
autogenerated on Fri Aug 28 2015 13:45:03