serviceclass.h

Go to the documentation of this file.

// OSB library ************************************************ -*- C++ -*-
/*
  AUTHOR(S): Tang Boon Leong (tbl)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.67 $

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

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

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

// + class declarations
namespace OSB_LIB {
    class Cdr;
    class UsedService;
}

namespace OSB_DB {
    struct ServiceClassGw;
    struct ScSystemGw;
    struct ScsVersionGw;
}

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

// ************************************************************************
// forward declarations
    class ScsVersion;

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

    // ********************************************************************
    // ServiceClass
    class ServiceClass : public TariffObject {
        friend struct OSB_DB::ServiceClassGw;

        friend class TariffCatalogue;
    public:
        typedef Id<ServiceClass> Oid;

        ServiceClass(const Oid& oid = Oid()) : oid_(oid) {};

        const Oid& oid() const;

        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_;
    };

    typedef std::list<ServiceClass> ServiceClasses;

    // ********************************************************************
    // MatchingTree
    class MatchingTree {
    private:
        // forward declaration of leaf class.
        class Leaf;
        typedef std::list<Leaf> Leaves;
    public:
        void populate(const ScsVersion& scsVs);

        void addService(const RatedService& rs);

        const RatedService::Oid
        match(const ServiceTuple& st) const;

        void swap(MatchingTree& rhs);

    private:
        void addService(
                  Leaves&            leaves,
                  ServiceElements    ses,
            const RatedService::Oid& rsId
        );

        const RatedService::Oid
        match(
            const Leaves&         leaves,
                  ServiceElements ses
        ) const;

    private:
        Leaves leaves_;
    };

    // ********************************************************************
    // MatchingTree::Leaf
    struct MatchingTree::Leaf {
        explicit Leaf(const ServiceElement& se);
    public:
        ServiceElement se_;
        RatedService::Oid rsId_;
        Leaves childs_;
    };                                  // class MatchingTree::Leaf

    // ********************************************************************
    // ScSystem
     class ScSystem : public TariffObject {
        friend struct OSB_DB::ScSystemGw;

        friend class TariffCatalogue;
     public:
        typedef Id<ScSystem> Oid;
     public:
        ScSystem(const Oid& oid = Oid()) : oid_(oid) {};
     public:
        const Oid& oid() const;
        const std::set<ServiceClass::Oid> supportedSc() const;

        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_;
     };

    typedef std::list<ScSystem> ScSystems;

    // ********************************************************************
    // ScsVersion
     class ScsVersion : public ToVersion {
        friend struct OSB_DB::ScsVersionGw;
        friend class TariffCatalogue;
     public:
        typedef Id2<ScsVersion> Oid;
        typedef std::set<ServiceClass::Oid> ScOids;
        typedef std::map<Id<RatedService>, ServiceClass::Oid> RsScMap;
     public:
        explicit ScsVersion(const Oid& oid = Oid());
        explicit ScsVersion(const ScSystem::Oid& scsId);



        const Oid& oid() const;
        ScSystem::Oid scsId() const;
        const RsScMap& config() const;

        void supportedSc(ScOids& scOids) const;



        void addService(
            const RatedService::Oid& rsId,
            const ServiceClass::Oid& scId
        );

        void delService(const Id<RatedService>& service);

        ServiceClass::Oid getSc(
            Cdr&         cdr,
            UsedService& us
        ) 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
        );

        void refreshMatchingTree();
     private:
        Oid oid_;
        RsScMap config_;
        MatchingTree mTree_;
     };

    typedef std::list<ScsVersion> ScsVersions;

}                                       // namespace OSB_LIB
#endif                                  // #ifndef _SERVICECLASS_H_

---