commit 9825660e73e13e4a353ec2c437ecf4e5233ab3f6
author Amithash Prasad <amithash@meta.com> Thu Dec 19 14:02:30 2024 -0800
committer Amithash Prasad <amithash@meta.com> Thu Jan 02 14:15:47 2025 -0800
tree d3f9c3b94666fa1cc0b9995a1cd33f8b73eb0d93
parent 0ce01d78adc0e16c4bf3c8429a992f0fd710d743

platform-mc: Refactor unit conversion out of constructor

This is a mostly non-functional refactor which moves code
duplicated across the two constructors to a common private
method which can be used by the constructors.

A minor side-effect introduced here is adding a new
sensorUnit member which could be used in the future.

Change-Id: I62ad69f843f1283a0695ff2ace814e454851fcf7
Signed-off-by: Amithash Prasad <amithash@meta.com>

platform-mc/numeric_sensor.cpp

diff --git a/platform-mc/numeric_sensor.cpp b/platform-mc/numeric_sensor.cpp
index ab59154..da468b3 100644
--- a/platform-mc/numeric_sensor.cpp
+++ b/platform-mc/numeric_sensor.cpp
@@ -40,23 +40,11 @@
     return true;
 }
 
-NumericSensor::NumericSensor(
-    const pldm_tid_t tid, const bool sensorDisabled,
-    std::shared_ptr<pldm_numeric_sensor_value_pdr> pdr, std::string& sensorName,
-    std::string& associationPath) : tid(tid), sensorName(sensorName)
+void NumericSensor::setSensorUnit(uint8_t baseUnit)
 {
-    if (!pdr)
-    {
-        throw sdbusplus::xyz::openbmc_project::Common::Error::InvalidArgument();
-    }
-
-    sensorId = pdr->sensor_id;
-    std::string path;
-    SensorUnit sensorUnit = SensorUnit::DegreesC;
-    MetricUnit metricUnit = MetricUnit::Count;
+    sensorUnit = SensorUnit::DegreesC;
     useMetricInterface = false;
-
-    switch (pdr->base_unit)
+    switch (baseUnit)
     {
         case PLDM_SENSOR_UNIT_DEGRESS_C:
             sensorNameSpace = "/xyz/openbmc_project/sensors/temperature/";
@@ -98,11 +86,27 @@
             break;
         default:
             lg2::error("Sensor {NAME} has Invalid baseUnit {UNIT}.", "NAME",
-                       sensorName, "UNIT", pdr->base_unit);
+                       sensorName, "UNIT", baseUnit);
             throw sdbusplus::xyz::openbmc_project::Common::Error::
                 InvalidArgument();
             break;
     }
+}
+
+NumericSensor::NumericSensor(
+    const pldm_tid_t tid, const bool sensorDisabled,
+    std::shared_ptr<pldm_numeric_sensor_value_pdr> pdr, std::string& sensorName,
+    std::string& associationPath) : tid(tid), sensorName(sensorName)
+{
+    if (!pdr)
+    {
+        throw sdbusplus::xyz::openbmc_project::Common::Error::InvalidArgument();
+    }
+
+    sensorId = pdr->sensor_id;
+    std::string path;
+    MetricUnit metricUnit = MetricUnit::Count;
+    setSensorUnit(pdr->base_unit);
 
     path = sensorNameSpace + sensorName;
     try
@@ -444,57 +448,8 @@
 
     sensorId = pdr->sensor_id;
     std::string path;
-    SensorUnit sensorUnit = SensorUnit::DegreesC;
     MetricUnit metricUnit = MetricUnit::Count;
-    useMetricInterface = false;
-
-    switch (pdr->base_unit)
-    {
-        case PLDM_SENSOR_UNIT_DEGRESS_C:
-            sensorNameSpace = "/xyz/openbmc_project/sensors/temperature/";
-            sensorUnit = SensorUnit::DegreesC;
-            break;
-        case PLDM_SENSOR_UNIT_VOLTS:
-            sensorNameSpace = "/xyz/openbmc_project/sensors/voltage/";
-            sensorUnit = SensorUnit::Volts;
-            break;
-        case PLDM_SENSOR_UNIT_AMPS:
-            sensorNameSpace = "/xyz/openbmc_project/sensors/current/";
-            sensorUnit = SensorUnit::Amperes;
-            break;
-        case PLDM_SENSOR_UNIT_RPM:
-            sensorNameSpace = "/xyz/openbmc_project/sensors/fan_pwm/";
-            sensorUnit = SensorUnit::RPMS;
-            break;
-        case PLDM_SENSOR_UNIT_WATTS:
-            sensorNameSpace = "/xyz/openbmc_project/sensors/power/";
-            sensorUnit = SensorUnit::Watts;
-            break;
-        case PLDM_SENSOR_UNIT_JOULES:
-            sensorNameSpace = "/xyz/openbmc_project/sensors/energy/";
-            sensorUnit = SensorUnit::Joules;
-            break;
-        case PLDM_SENSOR_UNIT_PERCENTAGE:
-            sensorNameSpace = "/xyz/openbmc_project/sensors/utilization/";
-            sensorUnit = SensorUnit::Percent;
-            break;
-        case PLDM_SENSOR_UNIT_COUNTS:
-        case PLDM_SENSOR_UNIT_CORRECTED_ERRORS:
-        case PLDM_SENSOR_UNIT_UNCORRECTABLE_ERRORS:
-            sensorNameSpace = "/xyz/openbmc_project/metric/count/";
-            useMetricInterface = true;
-            break;
-        case PLDM_SENSOR_UNIT_OEMUNIT:
-            sensorNameSpace = "/xyz/openbmc_project/metric/oem/";
-            useMetricInterface = true;
-            break;
-        default:
-            lg2::error("Sensor {NAME} has Invalid baseUnit {UNIT}.", "NAME",
-                       sensorName, "UNIT", pdr->base_unit);
-            throw sdbusplus::xyz::openbmc_project::Common::Error::
-                InvalidArgument();
-            break;
-    }
+    setSensorUnit(pdr->base_unit);
 
     path = sensorNameSpace + sensorName;
     try