Add missing documentation.

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

diff --git a/include/stg/tariff.h b/include/stg/tariff.h
index 3e150e32b050fd165e8f4b5534d9ac7fd63155b2..4f5b4166a11a11d41383007fe6377fb237b4d13d 100644 (file)
--- a/include/stg/tariff.h
+++ b/include/stg/tariff.h
@@ -38,7 +38,7 @@ public:
 
     enum TRAFF_TYPE { TRAFF_UP = 0, TRAFF_DOWN, TRAFF_UP_DOWN, TRAFF_MAX };
 
 
     enum TRAFF_TYPE { TRAFF_UP = 0, TRAFF_DOWN, TRAFF_UP_DOWN, TRAFF_MAX };
 

-    static std::string ChangePolicyToString(CHANGE_POLICY change_policy);
+    static std::string ChangePolicyToString(CHANGE_POLICY changePolicy);

     static CHANGE_POLICY StringToChangePolicy(const std::string& value);
 
     static std::string PeriodToString(PERIOD period);
     static CHANGE_POLICY StringToChangePolicy(const std::string& value);
 
     static std::string PeriodToString(PERIOD period);


@@ -58,7 +58,8 @@ public:
     virtual double  GetFee() const = 0;
     virtual double  GetFree() const = 0;
     virtual PERIOD  GetPeriod() const = 0;
     virtual double  GetFee() const = 0;
     virtual double  GetFree() const = 0;
     virtual PERIOD  GetPeriod() const = 0;

-    virtual CHANGE_POLICY  GetChangePolicy() 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;
 
     virtual const   std::string & GetName() const = 0;
     virtual void    SetName(const std::string & name) = 0;


@@ -67,12 +68,13 @@ 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 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
 };
 
 inline

-std::string TARIFF::ChangePolicyToString(TARIFF::CHANGE_POLICY change_policy)
+std::string TARIFF::ChangePolicyToString(TARIFF::CHANGE_POLICY changePolicy)

 {
 {

-switch (change_policy)
+switch (changePolicy)

     {
     case ALLOW: return "allow";
     case TO_CHEAP: return "to_cheap";
     {
     case ALLOW: return "allow";
     case TO_CHEAP: return "to_cheap";