tariffperiod.h

Go to the documentation of this file.

// OSB library ************************************************ -*- C++ -*-
/*
  AUTHOR(S): Wang Peng (wp)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.70 $

  License
   OSB rating and billing library for communication networks
   Copyright (C) 2004, 2005, 2006  OSB systems

   This file may be distributed and/or modify under the terms of the
   GNU General Public License (GPL) as published by the Free Software
   Foundation which is provided in the file LICENSE.GPL included in the
   packaging of this file.

   The file is distributed in the hope that it will be useful, but WITHOUT
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   for more details.

   Holders of a OSB Commercial License may use this file under the terms
   and conditions of this commercial license.
 */
#ifndef _TARIFFPERIOD_H_
#define _TARIFFPERIOD_H_

// ************************************************************************
// included header files
// + standard includes
#include <list>
#include <set>
#include <utility>
#include <map>
#include <vector>
#include <memory>

// + local headers
#include "osbid.h"
#include "chrono.h"
#include "tariffobject.h"

// ************************************************************************
// class declarations
namespace OSB_DB {
    class Session;
    class TariffSystemGw;
    struct DayClassGw;
    struct SpecialDateGw;
    struct TariffPeriodGw;
    struct TpSystemGw;
    struct TpsVersionGw;
}

namespace OSB_LIB {
    class OsbErrors;
}

// ************************************************************************
// namespace extensions
namespace OSB_LIB {

// Forward declarations
    class TariffCatalogue;

// ************************************************************************
// class definitions

    // ********************************************************************
    // DayClass
    class DayClass : public TariffObject,
                     public ToCfgBase
    {
        friend struct OSB_DB::DayClassGw;
        friend class TariffCatalogue;
    public:
        typedef Id<DayClass> Oid;
    public:
        explicit DayClass(const Oid& oid = Oid());
    public:
        const Oid& oid() const;
    public:
        bool setWeekday(
            Weekday wd,
            bool    add
        );

        bool matchWeekDay (const Weekday& weekday) const;

        bool read(const OSB_DB::Session& session);

    private:


        bool insert(const OSB_DB::Session& session);

        bool remove(const OSB_DB::Session& session);

        bool update(const OSB_DB::Session& session);



        bool freeze(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        );

        bool release(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        );

        bool revoke(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        );

        bool unfreeze(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        );

    private:
        Oid         oid_;       
        bool        mon_;       
        bool        tue_;       
        bool        wed_;       
        bool        thu_;       
        bool        fri_;       
        bool        sat_;       
        bool        sun_;       
    };

    typedef std::list<DayClass> DayClasses;

    // ********************************************************************
    // SpecialDate
    class SpecialDate {
        friend struct OSB_DB::SpecialDateGw;

        friend class TariffCatalogue;

        typedef Id<DayClass> DcId;

    public:
        typedef Id<SpecialDate> Oid;

    public:
        explicit SpecialDate(
            const Oid& oid = Oid()
        );

        const Oid& oid() const { return oid_; }
        const DcId& dcId() const { return dcId_; }
        const std::string& name () const { return name_; }
        const Date& date () const { return date_; }
        const bool& annual () const { return annual_; }
        const CfgStatus& status() const { return status_; }
        long objVs() const { return objVs_; }

        void setName(const std::string& name);

        void setAnnual(const bool newAnnual);

        void setDate(const Date& newDate);

        void setDcId(const DcId& dcId);

        bool gracePeriodExpired() const;



        bool read(const OSB_DB::Session& session);

    private:
        bool insert(const OSB_DB::Session& session);

        bool remove(const OSB_DB::Session& session);

        bool update(const OSB_DB::Session& session);



        bool check(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        );

        bool release(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        );

        bool revoke(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        );

        bool unfreeze(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        );

    private:
        Oid         oid_;       
        DcId        dcId_;      
        std::string name_;      
        Date        date_;      
        bool        annual_;    
        CfgStatus   status_;    
        long        objVs_;     
    };

    typedef std::list<SpecialDate> SpecialDates;

    // ********************************************************************
    // TariffPeriod
    class TariffPeriod : public TariffObject {
        friend struct OSB_DB::TariffPeriodGw;

        friend class TariffCatalogue;
    public:
        typedef Id<TariffPeriod> Oid;
    public:
        explicit TariffPeriod(
            const Oid& oid = Oid()
        );
    public:
        const Oid& oid() const;
        std::string color() const { return color_; }

        void setColor(const std::string& color);



        bool read(const OSB_DB::Session& session);

    private:
        bool insert(const OSB_DB::Session& session);

        bool remove(const OSB_DB::Session& session);

        bool update(const OSB_DB::Session& session);

    private:
        Oid oid_;
        std::string color_;
    };                                  // class TariffPeriod

    typedef std::list<TariffPeriod> TariffPeriods;

    typedef std::set<TariffPeriod::Oid> TpOidSet;

    // ********************************************************************
    // TpSystem
    class TpSystem : public TariffObject {
        friend class OSB_DB::TpSystemGw;
        friend class TariffCatalogue;
    public:
        typedef Id<TpSystem> Oid;
    public:
        explicit TpSystem(const Oid& oid = Oid());
    public:
        const Oid& oid() const;
        TpOidSet supportedTp() const;



        bool read(const OSB_DB::Session& session);

    private:
        bool insert(const OSB_DB::Session& session);

        bool remove(const OSB_DB::Session& session);

        bool update(const OSB_DB::Session& session);

    private:
        Oid         oid_;     
    };

    typedef std::list<TpSystem> TpSystems;

    // ********************************************************************
    // class TpsConfig
    class TpsConfig {
    public:
        typedef std::map<OSB_LIB::Time, TariffPeriod::Oid> SwitchTimes;
        typedef std::map<DayClass::Oid, SwitchTimes> DcMap;
    public:
        const DcMap& dcMap() const;



        void clear();
        void add(
            const DayClass::Oid&     dcId,
            const OSB_LIB::Time&     switchTime,
            const TariffPeriod::Oid& tpId
        );
        void remove(
            const DayClass::Oid& dcId,
            const OSB_LIB::Time& switchTime
        );
        void cleanup();
    private:
        DcMap dcMap_;
    };                                  // class TpsConfig

    // ********************************************************************
    // TpsVersion
    class TpsVersion : public ToVersion {
        friend struct OSB_DB::TpsVersionGw;

        friend class TariffCatalogue;
    public:
        typedef Id2<TpsVersion> Oid;
    public:
        explicit TpsVersion(const Oid& oid = Oid());
        explicit TpsVersion(const TpSystem::Oid& tpsId);
    public:
        const Oid& oid() const;
        TpSystem::Oid tpsId() const;
        const TpsConfig& config() const;

        TariffPeriod::Oid getTp(const DateTime& ts) const;

        void supportedTp(
            std::set<TariffPeriod::Oid>& tpOids
        ) const;

        void setConfig(const TpsConfig& cfg);

        bool read(const OSB_DB::Session& session);

    private:


        bool insert(const OSB_DB::Session& session);

        bool remove(const OSB_DB::Session& session);

        bool update(const OSB_DB::Session& session);



        bool freeze(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        );

        bool release(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        );

        bool revoke(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        );

        bool unfreeze(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        );

    private:
        Oid oid_;
        TpsConfig config_;
    };                                  // class TpsVersion

    typedef std::list<TpsVersion> TpsVersions;

// ************************************************************************
// inline definitions
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _TARIFFPERIOD_H_

---