configuration.h

Go to the documentation of this file.

// OSB library ********************************************* -*- C++ -*-
/*
  AUTHOR(S): Lilian Qin Lan (lan)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.18.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 _CONFIGURATION_H_
#define _CONFIGURATION_H_

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

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

// *********************************************************************
// class declarations
namespace OSB_DB {
    class Session;
    class ConfigurationGw;
}

namespace OSB_LIB {
    class Date;
}

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

    // *****************************************************************
    // class Configuration
    class Configuration {
        friend class OSB_DB::ConfigurationGw;
    public:
        enum ConfigType {
            ctUnknown  = '\0',          
            ctDate     = 'd',           
            ctLong     = 'l',           
            ctString   = 's'            
        };

        enum RetConvert {
            rcSuccess      = 0,         //<! Conversion OK.
            rcTypeMismatch = 1,         //<! Wrong #type_.
            rcErrConvert   = 2          //<! Error in conversion.
        };

    public:
        explicit Configuration(ModuleId module = mdUnknown);

        static ConfigType configType(char c);



        ModuleId module() const;
        const std::string& keyword() const;
        const std::string& value() const;
        ConfigType type() const;
        const std::string& desc() const;

        bool read(
            const OSB_DB::Session& session,
                  ModuleId         module,
            const std::string&     keyword
        );


        RetConvert convert(Date* pDest) const;
        RetConvert convert(long* pDest) const;
        RetConvert convert(std::string* pDest) const;

    private:
        ModuleId module_;
        std::string keyword_;
        std::string value_;
        ConfigType  type_;
        std::string desc_;
    };                                  // class Configuration

    // *****************************************************************
    // class ConfigList
    class ModuleConfig {
    public:


        typedef std::map<std::string, Configuration> List;
        typedef List::iterator Iterator;
        typedef List::const_iterator ConstIterator;
        typedef List::size_type SizeType;
        typedef List::key_type KeyType;


        const List& list() const { return list_; }
        SizeType size() const { return list_.size(); }
        ConstIterator begin() const { return list_.begin(); }
        ConstIterator end() const { return list_.end(); }

        long read(
            const OSB_DB::Session& session,
            const ModuleId         module
        );

        enum RetConvert {
            rcSuccess      = Configuration::rcSuccess,
            rcTypeMismatch = Configuration::rcTypeMismatch,
            rcErrConvert   = Configuration::rcErrConvert,
            rcNotFound     = 3
        };


        RetConvert convert(
                  Date*        pDest,
            const std::string& keyword
        ) const;
        RetConvert convert(
                  long*        pDest,
            const std::string& keyword
        ) const;
        RetConvert convert(
                  std::string* pDest,
            const std::string& keyword
        ) const;
    private:
        List list_;
    };                                  // class ModuleConfig
}
#endif                                  // #ifndef _CONFIGURATION_H_

---