My Project
optparam.hh
Go to the documentation of this file.
1/* -*- mia-c++ -*-
2 *
3 * This file is part of MIA - a toolbox for medical image analysis
4 * Copyright (c) Leipzig, Madrid 1999-2017 Gert Wollny
5 *
6 * MIA is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with MIA; if not, see <http://www.gnu.org/licenses/>.
18 *
19 */
20
21#ifndef ph_optparam_hh
22#define ph_optparam_hh
23
24#include <ostream>
25#include <memory>
26
27#include <mia/core/parameter.hh>
29
31
32class CXMLElement;
33
43{
44
45public:
46
48 typedef std::shared_ptr<CParameter > PParameter;
49
54 bool has_key(const std::string& key) const;
55
61 PParameter& operator [] (const std::string& key);
62
68 void set(const CParsedOptions& options);
69
74 void check_required() const;
75
80 void print_help(std::ostream& os)const;
81
86 void get_help_xml(CXMLElement& root)const;
87
92 void add_dependend_handlers(HandlerHelpMap& handler_map)const;
93private:
94 std::map<std::string, PParameter> m_params;
95};
96
98
99#endif
A class to hold a list of named parameters.
Definition: optparam.hh:43
void set(const CParsedOptions &options)
bool has_key(const std::string &key) const
std::shared_ptr< CParameter > PParameter
a shared pointer to a parameter to make handling easier
Definition: optparam.hh:48
void print_help(std::ostream &os) const
void add_dependend_handlers(HandlerHelpMap &handler_map) const
void check_required() const
void get_help_xml(CXMLElement &root) const
This class implements a facade for the xml Element.
Definition: xmlinterface.hh:50
#define NS_MIA_BEGIN
conveniance define to start the mia namespace
Definition: defines.hh:33
#define EXPORT_CORE
Macro to manage Visual C++ style dllimport/dllexport.
Definition: defines.hh:101
#define NS_MIA_END
conveniance define to end the mia namespace
Definition: defines.hh:36
std::map< std::string, std::string > CParsedOptions
Definition: optionparser.hh:38
std::map< std::string, const CPluginHandlerBase * > HandlerHelpMap
A map that is used to collect the plug-in handlers used in a program.
Definition: handlerbase.hh:45