Veethree D7 SDK
Loading...
Searching...
No Matches
src
libio
digital_in_channel.h
Go to the documentation of this file.
1
5
#ifndef DIGITAL_IN_CHANNEL_H
6
#define DIGITAL_IN_CHANNEL_H
7
8
#include "
digital_common.h
"
9
#include "
io_common.h
"
10
#include "
io_event_notification.h
"
11
12
#include <memory>
13
14
namespace
vsdk::io
{
15
16
class
digital_context
;
17
25
class
digital_in_channel
:
public
event_notification
{
// NOLINT(*-special-member-functions)
26
public
:
31
explicit
digital_in_channel
(
const
digital_in_descriptor
& desc);
37
explicit
digital_in_channel
(std::shared_ptr<digital_context_interface> instance,
38
const
digital_in_descriptor
& desc);
39
~digital_in_channel
() noexcept override;
40
45
digital_in_channel
(const
digital_in_channel
& other) = delete;
46
digital_in_channel
(
digital_in_channel
&& other) noexcept;
48
53
digital_in_channel
& operator=(const
digital_in_channel
& other) = delete;
54
digital_in_channel
& operator=(
digital_in_channel
&& other) noexcept;
56
61
digital_result
read
() const;
62
68
digital_in_descriptor
descriptor
() const;
69
70
protected:
82
bool
process_notification
(const
event_notification_descriptor
& desc) const noexcept override;
83
84
private:
85
struct impl;
86
std::unique_ptr<impl> _impl;
87
};
88
89
}
// namespace vsdk::io
90
91
#endif
// DIGITAL_IN_CHANNEL_H
vsdk::io::digital_context
The digital class.
Definition
digital_context.h:27
vsdk::io::digital_in_channel::digital_in_channel
digital_in_channel(const digital_in_descriptor &desc)
The class constructor.
vsdk::io::digital_in_channel::digital_in_channel
digital_in_channel(std::shared_ptr< digital_context_interface > instance, const digital_in_descriptor &desc)
The class constructor.
vsdk::io::digital_in_channel::descriptor
digital_in_descriptor descriptor() const
Return a descriptor with the channel configuration used when the class was instantiated.
vsdk::io::digital_in_channel::read
digital_result read() const
Read the current state of the input.
vsdk::io::digital_in_channel::process_notification
bool process_notification(const event_notification_descriptor &desc) const noexcept override
process_notification
vsdk::io::event_notification::event_notification
event_notification()
Class constructors.
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::digital_result
io_result< bool > digital_result
Digital result type.
Definition
io_common.h:77
vsdk::io::digital_in_descriptor
The digital_in_descriptor class.
Definition
digital_common.h:194
vsdk::io::event_notification_descriptor
The event_notification_descriptor class.
Definition
io_event_notification.h:55
Generated by
1.14.0