1 /**
2  * Copyright © 2019 IBM Corporation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #pragma once
17 
18 #include <string>
19 
20 namespace phosphor
21 {
22 namespace power
23 {
24 namespace regulators
25 {
26 
27 /**
28  * @class Device
29  *
30  * A hardware device, such as a voltage regulator or I/O expander.
31  */
32 class Device
33 {
34   public:
35     // Specify which compiler-generated methods we want
36     Device() = delete;
37     Device(const Device&) = delete;
38     Device(Device&&) = delete;
39     Device& operator=(const Device&) = delete;
40     Device& operator=(Device&&) = delete;
41     ~Device() = default;
42 
43     /**
44      * Constructor.
45      *
46      * @param id unique device ID
47      */
48     explicit Device(const std::string& id) : id{id}
49     {
50     }
51 
52     /**
53      * Returns the unique ID of this device.
54      *
55      * @return device ID
56      */
57     const std::string& getID() const
58     {
59         return id;
60     }
61 
62   private:
63     /**
64      * Unique ID of this device.
65      */
66     const std::string id{};
67 };
68 
69 } // namespace regulators
70 } // namespace power
71 } // namespace phosphor
72