A simple timing component. More...
#include <mipaveragetimer.h>
Inheritance diagram for MIPAverageTimer:
Collaboration diagram for MIPAverageTimer:
Public Member Functions | |
| MIPAverageTimer (MIPTime interval) | |
| Creates a timing object. More... | |
| void | reset () |
| Re-initializes the component. More... | |
 Public Member Functions inherited from MIPComponent | |
| virtual void | lock () |
| Locks the current component. More... | |
| virtual void | unlock () |
| Unlocks the current component. More... | |
| virtual bool | processFeedback (const MIPComponentChain &chain, int64_t feedbackChainID, MIPFeedback *feedback) |
| Add feedback information about this component. More... | |
| std::string | getComponentName () const |
| Returns the name of the component. More... | |
| Public Member Functions inherited from MIPErrorBase | |
| std::string | getErrorString () const |
| Returns the last known error description. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from MIPComponent | |
| MIPComponent (const std::string &componentName) | |
| Create a component with the specified name. More... | |
| Protected Member Functions inherited from MIPErrorBase | |
| void | setErrorString (const std::string &str) const |
| Stores an error description. More... | |
Detailed Description
This is a simple timing component which accepts MIPSYSTEMMESSAGE_WAITTIME system messages. It generates a MIPSYSTEMMESSAGE_ISTIME system message each time the specified interval has elapsed. Note that this is only on average after each interval: fluctuation will be present.
Constructor & Destructor Documentation
| MIPAverageTimer::MIPAverageTimer | ( | MIPTime | interval | ) |
Using this constructor, a timing object will be created which will generate messages eacht time interval has elapsed.
Member Function Documentation
| void MIPAverageTimer::reset | ( | ) |
The documentation for this class was generated from the following file:
- src/components/timer/mipaveragetimer.h
