Veethree D7 SDK
Loading...
Searching...
No Matches
src
libio
pwm_in_channel.h
Go to the documentation of this file.
1
5
#ifndef PWM_IN_CHANNEL_H
6
#define PWM_IN_CHANNEL_H
7
8
#include "
digital_common.h
"
9
#include "
io_common.h
"
10
#include "
io_event_notification.h
"
11
#include <memory>
12
13
namespace
vsdk::io
{
14
15
class
digital_context
;
16
23
class
pwm_in_channel
:
public
event_notification
{
// NOLINT(*-special-member-functions)
24
public
:
30
explicit
pwm_in_channel
(
const
pwm_in_descriptor
& desc);
37
explicit
pwm_in_channel
(std::shared_ptr<digital_context_interface> instance,
38
const
pwm_in_descriptor
& desc);
39
43
~pwm_in_channel
() noexcept override;
44
49
pwm_in_channel
(const
pwm_in_channel
& other) = delete;
50
pwm_in_channel
(
pwm_in_channel
&& other) noexcept;
52
57
pwm_in_channel
& operator=(const
pwm_in_channel
& other) = delete;
58
pwm_in_channel
& operator=(
pwm_in_channel
&& other) noexcept;
60
65
pwm_result
read
() const;
66
72
pwm_in_descriptor
descriptor
() const;
73
74
protected:
95
bool
process_notification
(const
event_notification_descriptor
& desc) const noexcept override;
96
97
private:
98
struct impl;
99
std::unique_ptr<impl> _impl;
100
};
101
102
}
// namespace vsdk::io
103
104
#endif
// PWM_IN_CHANNEL_H
vsdk::io::digital_context
The digital class.
Definition
digital_context.h:27
vsdk::io::event_notification::event_notification
event_notification()
Class constructors.
vsdk::io::pwm_in_channel::descriptor
pwm_in_descriptor descriptor() const
Return a descriptor with the channel configuration used when the class was instantiated.
vsdk::io::pwm_in_channel::process_notification
bool process_notification(const event_notification_descriptor &desc) const noexcept override
Process event notifications for PWM input channels.
vsdk::io::pwm_in_channel::read
pwm_result read() const
Read the current value of the channel.
vsdk::io::pwm_in_channel::pwm_in_channel
pwm_in_channel(const pwm_in_descriptor &desc)
The class constructor.
vsdk::io::pwm_in_channel::pwm_in_channel
pwm_in_channel(std::shared_ptr< digital_context_interface > instance, const pwm_in_descriptor &desc)
The class constructor.
vsdk::io::pwm_in_channel::~pwm_in_channel
~pwm_in_channel() noexcept override
The class destructor.
digital_common.h
Digital IO common types.
io_common.h
Common IO types and structures.
io_event_notification.h
IO event notification interface.
vsdk::io
Any entities that belong to the IO library.
vsdk::io::pwm_result
io_result< float > pwm_result
PWM result type.
Definition
io_common.h:72
vsdk::io::event_notification_descriptor
The event_notification_descriptor class.
Definition
io_event_notification.h:55
vsdk::io::pwm_in_descriptor
The pwm_in_descriptor class.
Definition
digital_common.h:218
Generated by
1.14.0