osbunit.h

Go to the documentation of this file.

// OSB library ************************************************ -*- C++ -*-
/*
  AUTHOR(S): Narendranath Reddy (nr)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.26.2.1 $

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

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

// + local headers
#include "osbtype.h"

// ************************************************************************
// class declarations
namespace OSB_LIB {
    class Decimal;
}

namespace OSB_DB {
    class  Session;
    struct UnitGw;
}

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

// ************************************************************************
// class definitions
    class Unit {
        friend class OSB_DB::UnitGw;
    public:
        typedef TypeId<Unit> Oid;
        enum UnitId {
            uiSeconds      =  1,
            uiMinutes      =  2,
            uiHours        =  3,
            uiDays         =  4,
            uiMonths       =  5,
            uiYears        =  6,
            uiBilledPeriod =  7,
            uiBytes        =  8,
            uiMessages     =  9,
            uiMax          = uiMessages
        };
    public:
        static UnitId unitId(const Oid& oid);
    public:
        Oid oid() const;
        UnitId unitId() const;
        const std::string& name() const;

        static bool canConvert(
            const Oid& lhs,
            const Oid& rhs
        );
        static Decimal convert(
            const Oid&     lhs,
            const Oid&     rhs,
            const Decimal& value
        );

    private:
        Oid oid_;
        std::string name_;
    };

    class UnitList {
        friend class OSB_DB::UnitGw;
    public:
        typedef std::map<Unit::Oid, Unit> Cont;
        typedef Cont::const_iterator ConstIterator;
    public:
        size_t size() const;
        ConstIterator begin() const;
        ConstIterator end() const;
        size_t read(const OSB_DB::Session& session);
        const Unit& getUnit(const Unit::Oid& oid) const;
        Unit::Oid getUnit(const std::string& name) const;
    private:
        Cont cont_;
    };
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _OSBUNIT_H_

---