Represents a PowerButton. More...
#include <PowerButton.h>
Inheritance diagram for rec::robotino::api2::PowerButton:
Public Member Functions | |
| void | setComId (const ComId &id) |
| bool | pressed () const |
| virtual void | pressedChanged (bool pressed) |
 Public Member Functions inherited from rec::robotino::api2::ComObject | |
| ComObject () | |
| virtual | ~ComObject () |
| ComId | comId () const |
Friends | |
| class | PowerButtonImpl |
Additional Inherited Members | |
| Protected Attributes inherited from rec::robotino::api2::ComObject | |
| ComId | _comID |
Detailed Description
Represents a PowerButton.
Member Function Documentation
| bool rec::robotino::api2::PowerButton::pressed | ( | ) | const |
Returns the current state of the PowerButton.
- Returns
- TRUE if the PowerButton has contact, FALSE otherwise
- Exceptions
-
RobotinoException if the underlying communication object is invalid
- See also
- ComObject::setComId
|
virtual |
Called when new readings are available.
- Remarks
- This function is called from the thread in which Com::processEvents() is called.
- See also
- Com::processEvents
| void rec::robotino::api2::PowerButton::setComId | ( | const ComId & | id | ) |
Sets the associated communication object.
- Parameters
-
id The id of the associated communication object.
- Exceptions
-
RobotinoException if given id is invalid.
- Remarks
- This function is thread save
The documentation for this class was generated from the following file:
- C:/srcs/git/openrobotino/api2/lib/rec/robotino/api2/PowerButton.h
