usagerecord.h

Go to the documentation of this file.

// OSB library ********************************************* -*- C++ -*-
/*
  AUTHOR(S): Andreas Huggel (ahu)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.26 $

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

// *********************************************************************
// included header files
// + standard includes
#include <string>
#include <vector>

// + local headers
#include "chrono.h"
#include "decimal.h"
#include "osbunit.h"
#include "contract.h"
#include "persproduct.h"
#include "product.h"
#include "chargetraits.h"
#include "tariff.h"
#include "tariffsystem.h"
#include "tariffperiod.h"
#include "tcdist.h"
#include "connectionpt.h"
#include "tariffclass.h"
#include "serviceclass.h"

// + class declarations
namespace OSB_LIB {
    class Cdr;
    class CdrList;
    class TariffCatalogue;
}

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

// *********************************************************************
// type definitions

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

    class Usagerecord {
    public:
        Usagerecord() {}

        // ToDo: To hold information of the origin of this usage record.
        long               callId;
        long               recordId;
        Contract::Oid      contractId;
        PersProduct::Oid   persProductId;
        ProductNode::Oid   productNodeId;
        Decimal            amount;
        ChargeTraits::Oid  chargeTraitsId;
        std::string        otherParty;
        Decimal            volume;
        Unit::Oid          unitId;
        DateTime           callStamp;
        Date               assigned;
        std::string        remark;
        TariffSystem::Oid  tsId;
        ServiceClass::Oid  scId;
        TariffPeriod::Oid  tpId;
        TariffClass::Oid   tcId;
        Tariff::Oid        flatTfId;
        Tariff::Oid        massTfId;
        TariffZone::Oid    tzId;
        ConnectionPt::Oid  ratedOriginId;
        ConnectionPt::Oid  ratedDestinationId;

        void readTariffInfoName(const TariffCatalogue& tcat);

        const std::string& tsName() const { return tsName_; }
        const std::string& scName() const { return scName_; }
        const std::string& tpName() const { return tpName_; }
        const std::string& tcName() const { return tcName_; }
        const std::string& flatTfName() const { return flatTfName_;}
        const std::string& massTfName() const { return massTfName_; }
        const std::string& tzName() const { return tzName_; }
        const std::string& ratedOriginName() const
        {
            return ratedOriginName_;
        }
        const std::string& ratedDestinationName() const
        {
            return ratedDestinationName_;
        }
    private:
        std::string     tsName_;
        std::string     scName_;
        std::string     tpName_;
        std::string     tcName_;
        std::string     flatTfName_;
        std::string     massTfName_;
        std::string     tzName_;
        std::string     ratedOriginName_;
        std::string     ratedDestinationName_;
    };

    typedef std::vector<Usagerecord> UrContainer;

    class Usagerecords {
    public:
         void write(
             const OSB_DB::Session& session,
                   bool             keepRecords = false
         );

        long read(
            const OSB_DB::Session& session,
                  long             size,
            const Contract::Oid&   contractId,
            const Date&            from,
            const Date&            upto
        );

        size_t cdr2Ur(const Cdr& cdr);

        size_t cdr2Ur(const CdrList& cdrContainer);

        UrContainer container;
    };
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _USAGERECORD_H_

---