senf::ppi::IntervalTimer Class Reference
High precision regularly signaled event. More...
#include <senf/PPI/IntervalTimer.hh>
Inheritance diagram for senf::ppi::IntervalTimer:
Public Member Functions | |
| void | interval (ClockService::clock_type interval, unsigned eventsPerInterval=1) |
| std::pair< ClockService::clock_type, unsigned > | interval () const |
 Public Member Functions inherited from senf::ppi::EventImplementation< IntervalTimerEventInfo > | |
| module::Module & | module () const |
| Module in which the event is registered. More... | |
| EventManager & | manager () const |
| EventManager of the event. More... | |
| Public Member Functions inherited from senf::ppi::EventDescriptor | |
| virtual | ~EventDescriptor () |
| bool | enabled () const |
| Check, whether the event is currently enabled. More... | |
| void | enabled (bool v) |
| Enable or disable the event. More... | |
Structors and default members | |
| IntervalTimer (ClockService::clock_type interval, unsigned eventsPerInterval=1) | |
| IntervalTimer () | |
Additional Inherited Members | |
| Public Types inherited from senf::ppi::EventImplementation< IntervalTimerEventInfo > | |
| typedef IntervalTimerEventInfo | Event |
| typedef detail::EventArgType< IntervalTimerEventInfo >::type | EventArg |
| Protected Types inherited from senf::ppi::EventImplementationHelper< EventType, Self > | |
| typedef detail::EventArgType< EventType >::type | EventArg |
| Protected Member Functions inherited from senf::ppi::EventImplementation< IntervalTimerEventInfo > | |
| EventImplementation () | |
| Protected Member Functions inherited from senf::ppi::EventDescriptor | |
| EventDescriptor () | |
| Protected Member Functions inherited from senf::ppi::EventImplementationHelper< EventType, Self > | |
| void | callback (EventArg event, ClockService::clock_type time) |
| Forward event to user callback. More... | |
| void | callback (EventArg event) |
| Forward event to user callback. More... | |
Detailed Description
High precision regularly signaled event.
An IntervalTimer signals an event eventsPerInterval times each interval nanoseconds. The event counter and timer are reset, whenever the event is disabled.
- See also
- IntervalTimerEventInfo
Definition at line 51 of file IntervalTimer.hh.
Constructor & Destructor Documentation
◆ IntervalTimer() [1/2]
|
explicit |
◆ IntervalTimer() [2/2]
| senf::ppi::IntervalTimer::IntervalTimer | ( | ) |
Member Function Documentation
◆ interval() [1/2]
| void senf::ppi::IntervalTimer::interval | ( | ClockService::clock_type | interval, |
| unsigned | eventsPerInterval = 1 |
||
| ) |
◆ interval() [2/2]
| std::pair<ClockService::clock_type, unsigned> senf::ppi::IntervalTimer::interval | ( | ) | const |
The documentation for this class was generated from the following files: