paramoption.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 mia_core_paramoption_hh
22 #define mia_core_paramoption_hh
23 
24 #include <mia/core/cmdoption.hh>
25 #include <mia/core/parameter.hh>
26 
27 
37 public:
45  CParamOption(char short_option, const char *long_opt, CParameter *param);
46 
47 private:
48  virtual void do_post_set();
49 
50  virtual const std::string do_get_value_as_string() const;
51  virtual void do_get_long_help_xml(std::ostream& os, CXMLElement& parent, HandlerHelpMap& handler_map) const;
52  virtual void do_get_long_help(std::ostream& os) const;
53  virtual bool do_set_value(const char *str_value);
54  virtual size_t do_get_needed_args() const;
55  virtual void do_write_value(std::ostream& os) const;
56 
57  std::unique_ptr<CParameter> m_param;
58 
59 };
60 
62 
63 #endif
The base class for all command line options.
Definition: cmdoption.hh:50
#define NS_MIA_BEGIN
conveniance define to start the mia namespace
Definition: defines.hh:33
The base class for parameters used in complex options.
Definition: parameter.hh:48
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:35
command line option that handles a parameter
Definition: paramoption.hh:36
This class implements a facade for the xml Element.
Definition: xmlinterface.hh:49
virtual void do_get_long_help(std::ostream &os) const
#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