regulators: Create SensorMonitoring class
Create C++ class that implements the 'sensor_monitoring' element from
the JSON config file. See sensor_monitoring.md for more information.
The execute() method of this class will be implemented in a future
commit.
Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: Ifd0530e54d71a5292e8f4e5cad0a13195e801ed8
diff --git a/phosphor-regulators/src/sensor_monitoring.hpp b/phosphor-regulators/src/sensor_monitoring.hpp
new file mode 100644
index 0000000..7572436
--- /dev/null
+++ b/phosphor-regulators/src/sensor_monitoring.hpp
@@ -0,0 +1,88 @@
+/**
+ * Copyright © 2020 IBM Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#pragma once
+
+#include "action.hpp"
+
+#include <memory>
+#include <utility>
+#include <vector>
+
+namespace phosphor::power::regulators
+{
+
+/**
+ * @class SensorMonitoring
+ *
+ * Defines how to read the sensors for a voltage rail, such as voltage output,
+ * current output, and temperature.
+ *
+ * Sensor values are measured, actual values rather than target values.
+ *
+ * Sensors are read once per second. The sensor values are stored on D-Bus,
+ * making them available to external interfaces like Redfish.
+ *
+ * Sensors are read by executing actions, such as PMBusReadSensorAction. To
+ * read multiple sensors for a rail, multiple actions need to be executed.
+ */
+class SensorMonitoring
+{
+ public:
+ // Specify which compiler-generated methods we want
+ SensorMonitoring() = delete;
+ SensorMonitoring(const SensorMonitoring&) = delete;
+ SensorMonitoring(SensorMonitoring&&) = delete;
+ SensorMonitoring& operator=(const SensorMonitoring&) = delete;
+ SensorMonitoring& operator=(SensorMonitoring&&) = delete;
+ ~SensorMonitoring() = default;
+
+ /**
+ * Constructor.
+ *
+ * @param actions actions that read the sensors for a rail
+ */
+ explicit SensorMonitoring(std::vector<std::unique_ptr<Action>> actions) :
+ actions{std::move(actions)}
+ {
+ }
+
+ /**
+ * Executes the actions to read the sensors for a rail.
+ */
+ void execute()
+ {
+ // TODO: Create ActionEnvironment, execute actions, store sensor values
+ // on D-Bus, catch and handle any exceptions
+ }
+
+ /**
+ * Returns the actions that read the sensors for a rail.
+ *
+ * @return actions
+ */
+ const std::vector<std::unique_ptr<Action>>& getActions() const
+ {
+ return actions;
+ }
+
+ private:
+ /**
+ * Actions that read the sensors for a rail.
+ */
+ std::vector<std::unique_ptr<Action>> actions{};
+};
+
+} // namespace phosphor::power::regulators