Easyuino  1.2.0
Printable.h
1 /*
2 MIT License
3 
4 Copyright (c) 2017 André Pires
5 
6 Permission is hereby granted, free of charge, to any person obtaining a copy
7 of this software and associated documentation files (the "Software"), to deal
8 in the Software without restriction, including without limitation the rights
9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 copies of the Software, and to permit persons to whom the Software is
11 furnished to do so, subject to the following conditions:
12 
13 The above copyright notice and this permission notice shall be included in all
14 copies or substantial portions of the Software.
15 
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 SOFTWARE.
23 */
24 /*
25 Printable.h
26 */
27 
28 #ifndef _EASYUINO_PRINTABLE_h
29 #define _EASYUINO_PRINTABLE_h
30 
31 #if defined(ARDUINO) && ARDUINO >= 100
32 #include <Arduino.h>
33 #else
34 #include "WProgram.h"
35 #endif
36 
37 #include "Utilities.h"
38 
39 namespace Easyuino {
40 
42  class Printable {
43 
44  #pragma region Public Virtual Common API Methods
45 
46  public:
49  virtual char* toString() const = 0;
50 
51  #pragma endregion
52 
54  friend Stream& operator<<(IN Stream & stream, IN const Printable& printable);
55 
56  };
57 
58 };
59 
60 #endif
Definition: Button.h:38
Provides an interface interface to write objects to a Stream.
Definition: Printable.h:42
friend Stream & operator<<(IN Stream &stream, IN const Printable &printable)
Write the object state string representation to a given stream (e.g: Used to print the obejct state t...
virtual char * toString() const =0
Used to return a string representation of the object state.