EmergencyStop Class Reference

This class implements a a software Emergency Stop. More...

#include <EmergencyStop.hpp>

List of all members.

Public Member Functions

 EmergencyStop (RTT::TaskContext *axes)
 Constructor of the EmergencyStop.
bool addEvent (RTT::TaskContext *task, const std::string &eventname)
 function to add an event that will fire the EmergencyStop
void callback (std::string message)
 Callback function, will be executed when one of the events is fired.

Detailed Description

This class implements a a software Emergency Stop.

It has a pointer to a nAxesVelocityController and will call stopAllAxes and lockAllAxes if needed. Different events from different components can be added. If one of the events is fired the nAxesVelocityController will be stopped.

Definition at line 35 of file EmergencyStop.hpp.


Constructor & Destructor Documentation

EmergencyStop ( RTT::TaskContext *  axes  )  [inline]

Constructor of the EmergencyStop.

Parameters:
axes pointer to an nAxesVelocityController (TaskContext)

Definition at line 43 of file EmergencyStop.hpp.


Member Function Documentation

bool addEvent ( RTT::TaskContext *  task,
const std::string &  eventname 
) [inline]

function to add an event that will fire the EmergencyStop

Parameters:
task pointer to the events' TaskContext
eventname name of the event
Returns:
true if eventhandler could be constructed, false otherwise

Definition at line 61 of file EmergencyStop.hpp.

References EmergencyStop::callback().

void callback ( std::string  message  )  [inline]

Callback function, will be executed when one of the events is fired.

Parameters:
message Message of the event, will be displayed in EmergencyStop message

Definition at line 87 of file EmergencyStop.hpp.

Referenced by EmergencyStop::addEvent().


The documentation for this class was generated from the following file:
Generated on Thu Dec 23 15:05:28 2010 for OrocosComponentLibrary by  doxygen 1.6.3