/usr/include/mia-2.2/mia/core/optparam.hh is in libmia-2.2-dev 2.2.2-1+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 | /* -*- mia-c++ -*-
*
* This file is part of MIA - a toolbox for medical image analysis
* Copyright (c) Leipzig, Madrid 1999-2014 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>
#include <libxml++/libxml++.h>
NS_MIA_BEGIN
/**
\ingroup cmdline
\brief A class to hold a list of named parameters.
It takes care of setting the parameters based on its names,
and can check whether required parameters are really set.
*/
class EXPORT_CORE CParamList {
public:
/// a shared pointer to a parameter to make handling easier
typedef std::shared_ptr<CParameter > PParameter;
/**
\param key
\returns true if the parameter list already has a parameter named \a key
*/
bool has_key(const std::string& key) const;
/**
The operator to access the parameters in the list
\param key the name of the parameter
\returns (shared) pointer to the associated parameter (or creates a new empty one)
*/
PParameter& operator [] (const std::string& key);
/**
Set all the parameters that are given in the option list. If a parameter is unknown to the list,
it throws an \a invalid_argument exception
\param options a map of <key, value> string pairs
*/
void set(const CParsedOptions& options);
/**
checks whether all required parameters have been set and throws an
\a invalid_argument exception if not.
*/
void check_required() const;
/**
prints out help strings for all parameters in the list
\param os the output stream to write the help to.
*/
void print_help(std::ostream& os)const;
/**
Append the help for this parameter list to the given root node
\param[in,out] root the root node of the XML tree
*/
void get_help_xml(xmlpp::Element& root)const;
/**
Add all plug-in handlers that may be called by processing this parameter list
\param[in,out] handler_map the map to add the handlers to
*/
void add_dependend_handlers(HandlerHelpMap& handler_map)const;
private:
std::map<std::string, PParameter> m_params;
};
NS_MIA_END
#endif
|