optparam.hh

Go to the documentation of this file.

/* -*- mia-c++  -*-
 *
 * This file is part of MIA - a toolbox for medical image analysis 
 * Copyright (c) Leipzig, Madrid 1999-2017 Gert Wollny
 *
 * MIA 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 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 MIA; if not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef ph_optparam_hh
#define ph_optparam_hh

#include <ostream>
#include <memory>

#include <mia/core/parameter.hh>
#include <mia/core/optionparser.hh>

NS_MIA_BEGIN

class CXMLElement; 

class EXPORT_CORE CParamList {

public:

        typedef std::shared_ptr<CParameter > PParameter;

        bool has_key(const std::string& key) const;

        PParameter& operator [] (const std::string& key);

        void set(const CParsedOptions& options);

        void check_required() const;

        void print_help(std::ostream& os)const;

        void get_help_xml(CXMLElement& root)const;  

        void add_dependend_handlers(HandlerHelpMap& handler_map)const; 
private:
        std::map<std::string, PParameter> m_params;
};

NS_MIA_END

#endif