tax.h

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.16 $

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

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

// + local headers
#include "decimal.h"
#include "money.h"
#include "amount.h"
#include "chargetraits.h"

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

// *********************************************************************
// type definitions
    typedef std::map<std::string,
            std::pair<std::string, Decimal> > ParaValue;

    class Tax {
    public:
        Tax(const TaxTraits& tt) : traits_(tt) {}
        virtual ~Tax() {}
        virtual TaxAmount calculate(const Money&) const =0;
        virtual std::ostream& write(std::ostream&) const =0;
        TaxIdVs oid() const { return traits_.taxIdVs(); }
        const TaxTraits& traits() const { return traits_; }
        // The name of the tax
        std::string name;
        // Lookup table providing parameter-name and parameter-value
        // (all values converted to strings)
        ParaValue paraValue;

    protected:
        TaxTraits traits_;
    };

    inline std::ostream& operator<<(std::ostream& o, const Tax& t)
        { return t.write(o); }

    class StandardTax : public Tax {
    public:
        StandardTax(const TaxTraits& tt,
                    const Decimal&   p,
                    const Decimal&   a)
            : Tax(tt), percentage_(p), absolute_(a) {}

        TaxAmount calculate(const Money&) const;
        std::ostream& write(std::ostream&) const;

    private:
        Decimal percentage_;
        Decimal absolute_;
    };

}                                       // namespace OSB_LIB
#endif                                  // #ifndef _TAX_H_

---