My Project
handlerbase.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_handlerbase_hh
22#define mia_core_handlerbase_hh
23
24#include <ostream>
25#include <fstream>
26#include <map>
27
28#include <mia/core/defines.hh>
29
31
32
33
34class CXMLElement;
36
45typedef std::map<std::string, const CPluginHandlerBase *> HandlerHelpMap;
46
57{
58public:
59
65 CPluginHandlerBase(const char *data_descr, const char *type_descr);
66
70 CPluginHandlerBase(const CPluginHandlerBase& other) = delete;
71
75 CPluginHandlerBase& operator = (const CPluginHandlerBase& other) = delete;
76
78
83 void print_short_help(std::ostream& os) const;
84
89 void print_help(std::ostream& os) const;
90
95 void get_xml_help(CXMLElement& root) const;
96
98 const std::string& get_descriptor() const;
99
100
104 void add_dependend_handlers(HandlerHelpMap& handler_map) const;
105
111 void get_string_help_description_xml(std::ostream& os, CXMLElement& root) const;
112
113
117 std::string get_handler_type_string() const;
118
119
125 bool validate_parameter_string(const std::string& s) const;
126
127private:
128
129 virtual void do_print_short_help(std::ostream& os) const = 0;
130 virtual void do_print_help(std::ostream& os) const = 0;
131 virtual void do_get_xml_help(CXMLElement& root) const = 0;
132 virtual void do_add_dependend_handlers(HandlerHelpMap& handler_map) const = 0;
133 virtual std::string get_handler_type_string_and_help(std::ostream& os) const;
134 virtual std::string do_get_handler_type_string() const;
135 virtual bool do_validate_parameter_string(const std::string& s) const;
136
137 std::string m_descriptor;
138};
139
140
141
142
144
145
146#endif
The base class for all plugin handlers.
void print_help(std::ostream &os) const
virtual ~CPluginHandlerBase()
CPluginHandlerBase(const char *data_descr, const char *type_descr)
void add_dependend_handlers(HandlerHelpMap &handler_map) const
void print_short_help(std::ostream &os) const
void get_string_help_description_xml(std::ostream &os, CXMLElement &root) const
const std::string & get_descriptor() const
CPluginHandlerBase(const CPluginHandlerBase &other)=delete
std::string get_handler_type_string() const
bool validate_parameter_string(const std::string &s) const
void get_xml_help(CXMLElement &root) const
This class implements a facade for the xml Element.
#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, const CPluginHandlerBase * > HandlerHelpMap
A map that is used to collect the plug-in handlers used in a program.