Add missing documentation.

[stg.git] / include / stg / tariff.h

diff --git a/include/stg/tariff.h b/include/stg/tariff.h
index d0bf20b6dd268ddf0f7b2fa772cedad1e89ebdb1..4f5b4166a11a11d41383007fe6377fb237b4d13d 100644 (file)
--- a/include/stg/tariff.h
+++ b/include/stg/tariff.h
@@ -26,16 +26,28 @@
 #include <string>
 #include <cstring>
 #include <ctime>
+#include <istream>
 
 struct TARIFF_DATA;
 
 class TARIFF {
 public:
+    enum CHANGE_POLICY { ALLOW = 0, TO_CHEAP, TO_EXPENSIVE, DENY };
+
     enum PERIOD { DAY = 0, MONTH };
 
+    enum TRAFF_TYPE { TRAFF_UP = 0, TRAFF_DOWN, TRAFF_UP_DOWN, TRAFF_MAX };
+
+    static std::string ChangePolicyToString(CHANGE_POLICY changePolicy);
+    static CHANGE_POLICY StringToChangePolicy(const std::string& value);
+
     static std::string PeriodToString(PERIOD period);
     static PERIOD StringToPeriod(const std::string& value);
 
+    static std::string TraffTypeToString(TRAFF_TYPE type);
+    static TRAFF_TYPE StringToTraffType(const std::string& value);
+    static TRAFF_TYPE IntToTraffType(int value);
+
     virtual ~TARIFF() {}
     virtual double  GetPriceWithTraffType(uint64_t up,
                                           uint64_t down,
@@ -46,6 +58,8 @@ public:
     virtual double  GetFee() const = 0;
     virtual double  GetFree() const = 0;
     virtual PERIOD  GetPeriod() const = 0;
+    virtual CHANGE_POLICY GetChangePolicy() const = 0;
+    virtual time_t  GetChangePolicyTimeout() const = 0;
 
     virtual const   std::string & GetName() const = 0;
     virtual void    SetName(const std::string & name) = 0;
@@ -54,8 +68,34 @@ public:
     virtual int64_t GetTraffByType(uint64_t up, uint64_t down) const = 0;
     virtual int     GetThreshold(int dir) const = 0;
     virtual const TARIFF_DATA & GetTariffData() const = 0;
+    virtual std::string TariffChangeIsAllowed(const TARIFF & to, time_t currentTime) const = 0;
 };
 
+inline
+std::string TARIFF::ChangePolicyToString(TARIFF::CHANGE_POLICY changePolicy)
+{
+switch (changePolicy)
+    {
+    case ALLOW: return "allow";
+    case TO_CHEAP: return "to_cheap";
+    case TO_EXPENSIVE: return "to_expensive";
+    case DENY: return "deny";
+    }
+return "allow"; // Classic behaviour.
+}
+
+inline
+TARIFF::CHANGE_POLICY TARIFF::StringToChangePolicy(const std::string& value)
+{
+if (strcasecmp(value.c_str(), "to_cheap") == 0)
+    return TO_CHEAP;
+if (strcasecmp(value.c_str(), "to_expensive") == 0)
+    return TO_EXPENSIVE;
+if (strcasecmp(value.c_str(), "deny") == 0)
+    return DENY;
+return ALLOW; // Classic behaviour.
+}
+
 inline
 std::string TARIFF::PeriodToString(TARIFF::PERIOD period)
 {
@@ -75,4 +115,48 @@ if (strcasecmp(value.c_str(), "day") == 0)
 return MONTH; // Classic behaviour.
 }
 
+inline
+std::string TARIFF::TraffTypeToString(TARIFF::TRAFF_TYPE type)
+{
+switch (type)
+    {
+    case TRAFF_UP: return "up";
+    case TRAFF_DOWN: return "down";
+    case TRAFF_UP_DOWN: return "up+down";
+    case TRAFF_MAX: return "max";
+    }
+return "up+down";
+}
+
+inline
+TARIFF::TRAFF_TYPE TARIFF::StringToTraffType(const std::string& value)
+{
+if (strcasecmp(value.c_str(), "up") == 0)
+    return TRAFF_UP;
+if (strcasecmp(value.c_str(), "down") == 0)
+    return TRAFF_DOWN;
+if (strcasecmp(value.c_str(), "up+down") == 0)
+    return TRAFF_UP_DOWN;
+if (strcasecmp(value.c_str(), "max") == 0)
+    return TRAFF_MAX;
+return TRAFF_UP_DOWN;
+}
+
+inline
+std::istream & operator>>(std::istream & stream, TARIFF::TRAFF_TYPE & traffType)
+{
+    unsigned val;
+    stream >> val;
+    traffType = static_cast<TARIFF::TRAFF_TYPE>(val);
+    return stream;
+}
+
+inline
+TARIFF::TRAFF_TYPE TARIFF::IntToTraffType(int value)
+{
+    if (value < 0 || value > TRAFF_MAX)
+        return TRAFF_UP_DOWN;
+    return static_cast<TRAFF_TYPE>(value);
+}
+
 #endif