RTT::dev::HomingInterface Class Reference

#include <HomingInterface.hpp>

List of all members.

Public Member Functions

virtual double homingDriveValue ()=0
virtual double homingDriveValue ()=0
 HomingInterface ()
 HomingInterface ()
virtual bool homingStatus ()=0
virtual bool homingStatus ()=0
virtual void resetHomingStatus ()=0
virtual void resetHomingStatus ()=0
virtual ~HomingInterface ()
virtual ~HomingInterface ()

Detailed Description

Definition at line 47 of file install/include/rtt/extras/dev/HomingInterface.hpp.


Constructor & Destructor Documentation

RTT::HomingInterface::~HomingInterface (  )  [virtual]

Definition at line 36 of file HomingInterface.cpp.

RTT::dev::HomingInterface::HomingInterface (  ) 

A HomingInterface provides all necessary data to perform axis homing.

virtual RTT::dev::HomingInterface::~HomingInterface (  )  [virtual]

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

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

Sets the homingstatus to false.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


rtt
Author(s): RTT Developers
autogenerated on Fri Jan 11 09:49:55 2013