section.h

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.34 $

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

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

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

#include "contract.h"
#include "persproduct.h"
#include "product.h"
#include "chargetraits.h"

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

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

// *********************************************************************
// type definitions
    enum SectionType {
        notSet             =     0,
        subsCharges        =   100,
        oneTimeCharges     =   200,
        international      =  1000,
        totalInternational =  1100,
        national           =  2000,
        totalNational      =  2100,
        localcall          =  3000,
        totalLocal         =  3100,
        productTotal       =  1200
    };

// *********************************************************************
// class definitions
    class Section {
        friend class BillingXml;
        friend class SumCdr01BillingXml;
    public:
        Section(PersProduct::UserId productUserId,
                PersProduct::Oid    persProductId,
                ProductNode::Oid    productNodeId,
                SectionType         sectionPart)
            : productUserId_(productUserId),
              persProductId_(persProductId),
              productNodeId_(productNodeId),
              sectionPart_(sectionPart) {}

        std::string str() const;
        bool operator==(const Section&) const;
        bool operator!=(const Section&) const;
        bool operator< (const Section&) const;
        bool operator> (const Section&) const;
        bool operator<=(const Section&) const;
        bool operator>=(const Section&) const;

        // returns the position of the first section part that differs
        // (from left, e.g., 2 if persProductId is not the same) and
        // 0 if both sections are equal.
        int compare(const Section& rhs) const;

        // get the section name for a section type identifier
        // ToDo: Should be implemented in a generic way as a separate
        // list of id/name pairs. Currently, both the types as well as
        // the names are hardcoded in the Section.
        std::string getName(const SectionType&) const;

        // return a global section for invoice items that are not
        // related to any specific section. globalSection() is < any
        // other section.
        static const Section& globalSection();

        // sections do not need to be complete.
        static const PersProduct::UserId NO_PROD_USER;
        static const PersProduct::Oid    NO_PERS_PROD;
        static const ProductNode::Oid    NO_PROD_NODE;
        static const SectionType         NO_SECTION_PART;

    private:
        PersProduct::UserId  productUserId_;
        PersProduct::Oid     persProductId_;
        ProductNode::Oid     productNodeId_;
        SectionType          sectionPart_;
    };
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _SECTION_H_

---