Orocos Real-Time Toolkit  2.9.0
Public Member Functions | List of all members
RTT::dev::HomingInterface Class Referenceabstract

#include <rtt/extras/dev/HomingInterface.hpp>

Public Member Functions

 HomingInterface ()
 A HomingInterface provides all necessary data to perform axis homing. More...
 
virtual ~HomingInterface ()
 
virtual bool homingStatus ()=0
 Returns true if a 'home switch event' has occurred (e.g. More...
 
virtual void resetHomingStatus ()=0
 Sets the homingstatus to false. More...
 
virtual double homingDriveValue ()=0
 Returns the recommended drive value for coarse movement to the home switch. More...
 

Detailed Description

Definition at line 47 of file HomingInterface.hpp.

Constructor & Destructor Documentation

RTT::HomingInterface::~HomingInterface ( )
virtual

Definition at line 37 of file HomingInterface.cpp.

Member Function Documentation

virtual double RTT::dev::HomingInterface::homingDriveValue ( )
pure virtual

Returns the recommended drive value for coarse movement to the home switch.

If the axis is driven with this value, a 'home switch event' is guaranteed to occur.

virtual bool RTT::dev::HomingInterface::homingStatus ( )
pure virtual

Returns true if a 'home switch event' has occurred (e.g.

a home switch pulsed or changed its state) since the last reset.

virtual void RTT::dev::HomingInterface::resetHomingStatus ( )
pure virtual

Sets the homingstatus to false.


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