Mistake on this page?
Report an issue in GitHub or email us
InterfaceDigitalOut.h
1 /*
2  * Mbed-OS Microcontroller Library
3  * Copyright (c) 2021 Embedded Planet
4  * Copyright (c) 2021 ARM Limited
5  * SPDX-License-Identifier: Apache-2.0
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License
18  */
19 
20 #ifndef MBED_INTERFACE_DIGITALOUT_H_
21 #define MBED_INTERFACE_DIGITALOUT_H_
22 
23 #include "PinNames.h"
24 
25 namespace mbed {
26 
27 class DigitalOut;
28 
29 namespace interface {
30 
31 #ifdef FEATURE_EXPERIMENTAL_API
32 
33 // TODO - move method doxygen comments to interface once this polymorphism is mainstream
34 
35 // Pure interface definition for DigitalOut
36 struct DigitalOut {
37  virtual ~DigitalOut() = default;
38  virtual void write(int value) = 0;
39  virtual int read() = 0;
40  virtual int is_connected() = 0;
41 
42  DigitalOut &operator= (int value)
43  {
44  // Underlying implementation is responsible for thread-safety
45  write(value);
46  return *this;
47  }
48 
50  {
51  // Underlying implementation is responsible for thread-safety
52  write(rhs.read());
53  return *this;
54  }
55 
56  operator int()
57  {
58  // Underlying implementation is responsible for thread-safety
59  return read();
60  }
61 
62 };
63 #else
65 #endif /* FEATURE_EXPERIMENTAL_API */
66 
67 } // namespace interface
68 } // namespace mbed
69 
70 
71 #endif /* MBED_INTERFACE_DIGITALOUT_H_ */
DigitalOut & operator=(int value)
A shorthand for write()
Definition: DigitalOut.h:122
DigitalOut(PinName pin)
Create a DigitalOut connected to the specified pin.
Definition: DigitalOut.h:62
int is_connected()
Return the output setting, represented as 0 or 1 (int)
Definition: DigitalOut.h:108
int read()
Return the output setting, represented as 0 or 1 (int)
Definition: DigitalOut.h:96
A digital output, used for setting the state of a pin.
Definition: DigitalOut.h:51
Definition: ATHandler.h:46
void write(int value)
Set the output, specified as 0 or 1 (int)
Definition: DigitalOut.h:84
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.