config_option.hpp

//
// (c) Copyright 2012 DESY, Eugen Wintersberger <eugen.wintersberger@desy.de>
//
// This file is part of libpnicore.
//
// libpnicore is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 2 of the License, or
// (at your option) any later version.
//
// libpnicore 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.
//
// You should have received a copy of the GNU General Public License
// along with libpnicore.  If not, see <http://www.gnu.org/licenses/>.
//
// ============================================================================
//
// Created on: Dec 27, 2012
//     Author: Eugen Wintersberger <eugen.wintersberger@desy.de>
//

#pragma once

#include "../types.hpp"


namespace pni{
namespace core{
    
    template<typename T>
    class config_option
    {
        private:
            string _long_name;

            string _short_name;

            string _description;

            T _default_value;

            const T *_ext_reference;

            bool _has_default;

        public:
            //------------------------------------------------------------------
            config_option();

            //------------------------------------------------------------------
            config_option(const string &lname,const string &sname,
                          const string &description,T *exref=nullptr);

            //-----------------------------------------------------------------
            config_option(const string &lname,const string &sname,
                          const string &description,T default_value,
                          T *exref=nullptr);

            //-----------------------------------------------------------------
            virtual ~config_option() {}

            //-----------------------------------------------------------------
            string long_name() const { return _long_name; }

            //-----------------------------------------------------------------
            string short_name() const { return _short_name; }

            //-----------------------------------------------------------------
            string description() const { return _description; }

            //-----------------------------------------------------------------
            T default_value() const { return _default_value; }

            //-----------------------------------------------------------------
            const T *external_reference() const { return _ext_reference; }

            //-----------------------------------------------------------------
            bool has_default() const { return _has_default; }

    };

    //--------------------------------------------------------------------------
    template<typename T> config_option<T>::config_option():
        _long_name(),
        _short_name(),
        _description(),
        _default_value(),
        _ext_reference(nullptr),
        _has_default(false)
    {}

    //--------------------------------------------------------------------------
    template<typename T>
    config_option<T>::config_option(const string &lname,const string &sname,
                                    const string &description,T *exref):
        _long_name(lname),
        _short_name(sname),
        _description(description),
        _default_value(),
        _ext_reference(exref),
        _has_default(false)
    {}

    //--------------------------------------------------------------------------
    template<typename T>
    config_option<T>::config_option(const string &lname,const string &sname,
                                    const string &description,T default_value,
                                    T *exref):
        _long_name(lname),
        _short_name(sname),
        _description(description),
        _default_value(default_value),
        _ext_reference(exref),
        _has_default(true)
    {}

//end of namespace 
}
}