From 122b843fdef01a66c602d1270d50b7db576e7167 Mon Sep 17 00:00:00 2001
From: "William A. Kennington III" <wak@google.com>
Date: Tue, 30 Oct 2018 18:39:21 -0700
Subject: control: Rename Timer -> TimerConf

It is confusing to read some of the type definitions that deal with
timers when Timer could mean a timer instantiation or a set of timer
configuration parameters. This change disambiguates the two types.

Tested:
    Built and run through unit tests.

Change-Id: I9dd6b47886747d56a86b6a50eb9a74a331d0a1fe
Signed-off-by: William A. Kennington III <wak@google.com>
---
 control/actions.cpp                      | 3 ++-
 control/actions.hpp                      | 2 +-
 control/gen-fan-zone-defs.py             | 2 +-
 control/templates/defs.mako              | 2 +-
 control/templates/fan_zone_defs.mako.cpp | 2 +-
 control/types.hpp                        | 8 ++++----
 control/zone.cpp                         | 8 ++++----
 7 files changed, 14 insertions(+), 13 deletions(-)

(limited to 'control')

diff --git a/control/actions.cpp b/control/actions.cpp
index 71f7f72..923b1cc 100644
--- a/control/actions.cpp
+++ b/control/actions.cpp
@@ -11,7 +11,8 @@ namespace action
 
 using namespace phosphor::fan;
 
-Action call_actions_based_on_timer(Timer&& tConf, std::vector<Action>&& actions)
+Action call_actions_based_on_timer(TimerConf&& tConf,
+                                   std::vector<Action>&& actions)
 {
     return [tConf = std::move(tConf),
             actions = std::move(actions)](control::Zone& zone,
diff --git a/control/actions.hpp b/control/actions.hpp
index b079bf4..cce481c 100644
--- a/control/actions.hpp
+++ b/control/actions.hpp
@@ -26,7 +26,7 @@ namespace action
  *     An Action function that creates a timer
  */
 Action call_actions_based_on_timer(
-        Timer&& tConf,
+        TimerConf&& tConf,
         std::vector<Action>&& actions);
 
 /**
diff --git a/control/gen-fan-zone-defs.py b/control/gen-fan-zone-defs.py
index 0ddfb63..3db9a40 100755
--- a/control/gen-fan-zone-defs.py
+++ b/control/gen-fan-zone-defs.py
@@ -125,7 +125,7 @@ def getActions(edata, actions, events):
                 else:
                     if p == 'timer':
                         param = (
-                            "Timer{static_cast<std::chrono::seconds>(" +
+                            "TimerConf{static_cast<std::chrono::seconds>(" +
                             str(eActions[p]['delay']) + "), " +
                             "TimerType::" +
                             str(eActions[p]['type']) + "}")
diff --git a/control/templates/defs.mako b/control/templates/defs.mako
index 0980f81..2fd3856 100644
--- a/control/templates/defs.mako
+++ b/control/templates/defs.mako
@@ -58,7 +58,7 @@ make_action(action::${a['name']}
 ),
 %endfor
 },
-Timer{
+TimerConf{
     ${event['timer']['interval']},
     ${event['timer']['type']}
 },
diff --git a/control/templates/fan_zone_defs.mako.cpp b/control/templates/fan_zone_defs.mako.cpp
index e735e0d..fdf5bb2 100644
--- a/control/templates/fan_zone_defs.mako.cpp
+++ b/control/templates/fan_zone_defs.mako.cpp
@@ -120,7 +120,7 @@ const std::vector<ZoneGroup> Manager::_zoneLayouts
                         ),
                         %endif
                         },
-                        Timer{
+                        TimerConf{
                             ${event['pc']['pctime']['interval']},
                             ${event['pc']['pctime']['type']}
                         },
diff --git a/control/types.hpp b/control/types.hpp
index f565333..967b0b4 100644
--- a/control/types.hpp
+++ b/control/types.hpp
@@ -65,8 +65,8 @@ using Service = std::tuple<std::string, bool>;
 constexpr auto intervalPos = 0;
 constexpr auto typePos = 1;
 using TimerType = phosphor::fan::util::Timer::TimerType;
-using Timer = std::tuple<std::chrono::seconds,
-                         TimerType>;
+using TimerConf = std::tuple<std::chrono::seconds,
+                             TimerType>;
 
 constexpr auto sigMatchPos = 0;
 constexpr auto sigHandlerPos = 1;
@@ -74,11 +74,11 @@ using Signal = std::tuple<std::string, Handler>;
 
 constexpr auto groupPos = 0;
 constexpr auto actionsPos = 1;
-constexpr auto timerPos = 2;
+constexpr auto timerConfPos = 2;
 constexpr auto signalsPos = 3;
 using SetSpeedEvent = std::tuple<Group,
                                  std::vector<Action>,
-                                 Timer,
+                                 TimerConf,
                                  std::vector<Signal>>;
 
 constexpr auto eventGroupPos = 0;
diff --git a/control/zone.cpp b/control/zone.cpp
index 11246db..5f0c15d 100644
--- a/control/zone.cpp
+++ b/control/zone.cpp
@@ -332,8 +332,8 @@ void Zone::initEvent(const SetSpeedEvent& event)
         _signalEvents.emplace_back(std::move(eventData), std::move(match));
     }
     // Attach a timer to run the action of an event
-    auto eventTimer = std::get<timerPos>(event);
-    if (std::get<intervalPos>(eventTimer) != seconds(0))
+    auto timerConf = std::get<timerConfPos>(event);
+    if (std::get<intervalPos>(timerConf) != seconds(0))
     {
         // Associate event data with timer
         std::unique_ptr<EventData> eventData =
@@ -354,8 +354,8 @@ void Zone::initEvent(const SetSpeedEvent& event)
                  });
         if (!timer->running())
         {
-            timer->start(std::get<intervalPos>(eventTimer),
-                         std::get<typePos>(eventTimer));
+            timer->start(std::get<intervalPos>(timerConf),
+                         std::get<typePos>(timerConf));
         }
         addTimer(std::move(eventData), std::move(timer));
     }
-- 
cgit v1.2.1