blob: 636a264dbbb5e7298ab64d19f9002a0f905f0e37 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
/**
* \file
* \brief SoftwareTimerCommon class header
*
* \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info
*
* \par License
* This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not
* distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#ifndef INCLUDE_DISTORTOS_SOFTWARETIMERCOMMON_HPP_
#define INCLUDE_DISTORTOS_SOFTWARETIMERCOMMON_HPP_
#include "distortos/SoftwareTimer.hpp"
#include "distortos/internal/scheduler/SoftwareTimerControlBlock.hpp"
namespace distortos
{
/**
* \brief SoftwareTimerCommon class implements common functionality of software timers
*
* \ingroup softwareTimers
*/
class SoftwareTimerCommon : public SoftwareTimer
{
public:
/**
* \brief SoftwareTimerCommon's constructor
*/
constexpr SoftwareTimerCommon() :
softwareTimerControlBlock_{softwareTimerRunner, *this}
{
}
/**
* \brief SoftwareTimerCommon's destructor
*/
~SoftwareTimerCommon() override;
/**
* \return true if the timer is running, false otherwise
*/
bool isRunning() const override;
/**
* \brief Starts the timer.
*
* \param [in] timePoint is the time point at which the function will be executed
*
* \return 0 on success, error code otherwise
*/
int start(TickClock::time_point timePoint) override;
using SoftwareTimer::start;
/**
* \brief Stops the timer.
*
* \return 0 on success, error code otherwise
*/
int stop() override;
SoftwareTimerCommon(const SoftwareTimerCommon&) = delete;
SoftwareTimerCommon(SoftwareTimerCommon&&) = default;
const SoftwareTimerCommon& operator=(const SoftwareTimerCommon&) = delete;
SoftwareTimerCommon& operator=(SoftwareTimerCommon&&) = delete;
private:
/// internal SoftwareTimerControlBlock object
internal::SoftwareTimerControlBlock softwareTimerControlBlock_;
};
} // namespace distortos
#endif // INCLUDE_DISTORTOS_SOFTWARETIMERCOMMON_HPP_
|
