My Project
paramtranslator.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_paramtranslator_hh
22
#define mia_core_paramtranslator_hh
23
24
#include <map>
25
#include <set>
26
#include <string>
27
#include <ostream>
28
29
#include <
mia/core/defines.hh
>
30
#include <
mia/core/optparam.hh
>
31
32
NS_MIA_BEGIN
33
34
class
EXPORT_CORE
CParamTranslator
35
{
36
public
:
37
CParamTranslator
(
const
char
*name);
38
39
virtual
~
CParamTranslator
();
40
48
void
add_parameter(
const
std::string& name,
CParameter
*param);
49
57
void
set_parameters(
const
CParsedOptions
& options);
58
63
void
check_parameters();
64
65
void
get_short_help(std::ostream& os)
const
;
66
67
void
get_help(std::ostream& os)
const
;
68
69
void
get_help_xml(
CXMLElement
& root)
const
;
70
71
virtual
void
do_get_help_xml(
CXMLElement
& root)
const
;
72
74
const
char
*get_name()
const
;
75
77
const
std::string get_descr()
const
;
78
protected
:
79
CParamList
& get_parameters();
80
81
private
:
82
virtual
const
std::string do_get_descr()
const
= 0;
83
84
CParamList
m_parameters;
85
86
// plugin name
87
const
char
*m_name;
88
89
};
90
91
NS_MIA_END
92
93
#endif
CParsedOptions
std::map< std::string, std::string > CParsedOptions
Definition:
optionparser.hh:38
NS_MIA_BEGIN
#define NS_MIA_BEGIN
conveniance define to start the mia namespace
Definition:
defines.hh:33
CParameter
The base class for parameters used in complex options.
Definition:
parameter.hh:48
NS_MIA_END
#define NS_MIA_END
conveniance define to end the mia namespace
Definition:
defines.hh:36
CXMLElement
This class implements a facade for the xml Element.
Definition:
xmlinterface.hh:49
optparam.hh
EXPORT_CORE
#define EXPORT_CORE
Macro to manage Visual C++ style dllimport/dllexport.
Definition:
defines.hh:101
CParamList
A class to hold a list of named parameters.
Definition:
optparam.hh:42
CParamTranslator
Definition:
paramtranslator.hh:34
defines.hh
mia
core
paramtranslator.hh
Generated by
1.8.16