tariffsystem.h

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.171 $

  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 _TARIFFSYSTEM_H_
#define _TARIFFSYSTEM_H_

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

// + local headers
#include "tariffobject.h"
#include "tariff.h"
#include "tariffclass.h"
#include "tariffperiod.h"
#include "serviceclass.h"
#include "osbid.h"
#include "chrono.h"

// *********************************************************************
// class declarations
namespace OSB_DB {
    class Session;
    class TariffSystemGw;
    struct TsVersionGw;
}

namespace OSB_LIB {
    class Unit;
    class Cdr;
}

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

// ************************************************************************
// forward declarations
    class TsVersion;

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

    // *****************************************************************
    // TariffSystem
    class TariffSystem : public TariffObject {
        friend class OSB_DB::TariffSystemGw;

        friend class TariffCatalogue;

    public:
        typedef Id<TariffSystem> Oid;

        struct AuthenType {
            AuthenType()
              : status(1), volume(0)
            {
                // empty body
            }

            long status;
            TypeId<Unit> unitId;
            Decimal volume;
        };

    public:
        explicit TariffSystem(const Oid& oid = Oid());
    public:
        const Oid& oid() const;
        const AuthenType rate(
                  Cdr&   cdr,
            const Money& money
        );

        void rate(Cdr& cdr);

        bool getTariffInfo(
                  Cdr&         cdr,
                  UsedService& us,
            const TsVersion&   tsVs
        );

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

    private:


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

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

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

    private:
        Oid oid_;
    };                                  // TariffSystem

    typedef std::list<TariffSystem> TariffSystems;

    typedef std::map<ServiceClass::Oid, TcSystem::Oid> ScTcsCfg;

    typedef std::map<TariffClass::Oid, TpSystem::Oid> TcTpsCfg;

    typedef std::pair<TariffClass::Oid, TariffPeriod::Oid> TcTp;

    typedef std::map<TcTp, Tariff::Oid> TcTpTariff;

    // *****************************************************************
    // Tariff system version
    class TsVersion : public ToVersion {
        friend struct OSB_DB::TsVersionGw;
        friend class TariffCatalogue;
    public:
        enum RatingType {
            flatRating  = 1,
            sumRating     = 2,
            unknownRating = -1
        };

        typedef Id2<TsVersion> Oid;
        typedef Id<ScSystem> ScsOid;
    public:
        static long rtToLong(const RatingType type);
        static RatingType longToRt(const long type);
    public:
        explicit TsVersion(
            const Oid&       oid  = Oid(),
                  RatingType type = flatRating
        );
        explicit TsVersion(
            const TariffSystem::Oid& tsId,
                  RatingType         type = flatRating
        );
    public:
        const Oid& oid() const;
        TariffSystem::Oid tsId() const;
        RatingType ratingType() const;



        const ScsOid& scsId() const;
        const ScTcsCfg& scTcsCfg() const;
        const TcTpsCfg& tcTpsCfg() const;
        const TcTpTariff& tcTpFlatTariff() const;
        const TcTpTariff& tcTpMassTariff() const;



        const TcSystem::Oid&
        getTcSystem(const ServiceClass::Oid& scId) const;

        const TpSystem::Oid&
        getTpSystem(const TariffClass::Oid& tcId) const;

        const Tariff::Oid& getFlatTariff(
            const TariffClass::Oid&  tcId,
            const TariffPeriod::Oid& tpId
        ) const;

        const Tariff::Oid& getMassTariff(
            const TariffClass::Oid&  tcId,
            const TariffPeriod::Oid& tpId
        ) const;



        void getSupportedScOid(
            std::set<ServiceClass::Oid>& scOids
        ) const;
        void getSupportedTcOid(
            std::set<TariffClass::Oid>& tcOids
        ) const;
        void getSupportedTpOid(
            std::set<TariffPeriod::Oid>& tpOids
        ) const;
        void getSupportedTcTpOid(std::set<TcTp>& tcTpOids) const;



        void copyCfg(const TsVersion& src);

        void setRatingType(const RatingType rt);
        void setScsId(const ScsOid& scsId);

        void setScTcsCfg(
            const ScTcsCfg& scTcsCfg
        );

        void setScTcsCfg(
            const ServiceClass::Oid& scId,
            const TcSystem::Oid&     tcsId
        );

        void setTcTpsCfg(
            const TcTpsCfg& tcTpsCfg
        );

        void setTcTpsCfg(
            const TariffClass::Oid& tcOid,
            const TpSystem::Oid&    tpsOid
        );

        void setFlatTariff(const TcTpTariff& flatTf);
        void setTcTpFlatTariff(
            const TcTp&        tcTp,
            const Tariff::Oid& tariffOid
        );

        void setMassTariff(const TcTpTariff& massTf);
        void setTcTpMassTariff(
            const TcTp&        tcTp,
            const Tariff::Oid& tariffOid
        );



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

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

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

        bool remove(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
        );

        void repopulateScTcsConfig();
        void repopulateTcTpsConfig();
        void repopulateTcTpFlatTariff();
        void repopulateTcTpMassTariff();

    private:
        Oid         oid_;
        ScsOid      scsOid_;
        RatingType  ratingType_;
        ScTcsCfg    scTcsCfg_;
        TcTpsCfg    tcTpsCfg_;
        TcTpTariff  tcTpFlatTariff_;
        TcTpTariff  tcTpMassTariff_;
    };                                  // TsVersion

    typedef std::list<TsVersion> TsVersions;
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _TARIFFSYSTEM_H_

---