ParsedTools::Proxy< SourceClass > Class Template Reference

A proxy ParameterAcceptor wrapper for classes that have a member function add_parameters, which takes a ParameterHandler as argument, and use the ParameterHandler::add_parameter() method to add parameters. More...

#include <proxy.h>

Inheritance diagram for ParsedTools::Proxy< SourceClass >:

Public Member Functions
template<typename... Args>
	Proxy (const std::string &section_name, Args... args)
	Default constructor. More...
Public Member Functions inherited from ParameterAcceptor
	ParameterAcceptor (const std::string &section_name="")
unsigned int	get_acceptor_id () const
virtual	~ParameterAcceptor () override
virtual void	declare_parameters (ParameterHandler &prm)
virtual void	parse_parameters (ParameterHandler &prm)
std::string	get_section_name () const
std::vector< std::string >	get_section_path () const
void	add_parameter (const std::string &entry, ParameterType &parameter, const std::string &documentation="", ParameterHandler &prm_=prm, const Patterns::PatternBase &pattern=*Patterns::Tools::Convert< ParameterType >::to_pattern())
void	enter_subsection (const std::string &subsection)
void	leave_subsection ()
void	enter_my_subsection (ParameterHandler &prm)
void	leave_my_subsection (ParameterHandler &prm)
void	serialize (Archive &ar, const unsigned int version)
void	subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
void	unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
unsigned int	n_subscriptions () const
void	list_subscribers (StreamType &stream) const
void	list_subscribers () const
void	subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
void	unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
unsigned int	n_subscriptions () const
void	list_subscribers (StreamType &stream) const
void	list_subscribers () const
Public Member Functions inherited from Subscriptor
	Subscriptor ()
	Subscriptor (const Subscriptor &)
	Subscriptor (Subscriptor &&) noexcept
virtual	~Subscriptor ()
Subscriptor &	operator= (const Subscriptor &)
Subscriptor &	operator= (Subscriptor &&) noexcept
void	serialize (Archive &ar, const unsigned int version)
void	subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
void	unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
unsigned int	n_subscriptions () const
void	list_subscribers (StreamType &stream) const
void	list_subscribers () const
void	subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
void	unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
unsigned int	n_subscriptions () const
void	list_subscribers (StreamType &stream) const
void	list_subscribers () const

Additional Inherited Members
Static Public Member Functions inherited from ParameterAcceptor
static void	initialize (const std::string &filename="", const std::string &output_filename="", const ParameterHandler::OutputStyle output_style_for_output_filename=ParameterHandler::Short, ParameterHandler &prm=ParameterAcceptor::prm, const ParameterHandler::OutputStyle output_style_for_filename=ParameterHandler::DefaultStyle)
static void	initialize (std::istream &input_stream, ParameterHandler &prm=ParameterAcceptor::prm)
static void	clear ()
static void	parse_all_parameters (ParameterHandler &prm=ParameterAcceptor::prm)
static void	declare_all_parameters (ParameterHandler &prm=ParameterAcceptor::prm)
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)
Static Public Member Functions inherited from Subscriptor
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)
Public Attributes inherited from ParameterAcceptor
boost::signals2::signal< void()>	declare_parameters_call_back
boost::signals2::signal< void()>	parse_parameters_call_back
Static Public Attributes inherited from ParameterAcceptor
static ParameterHandler	prm
Protected Attributes inherited from ParameterAcceptor
const std::string	section_name
std::vector< std::string >	subsections

Detailed Description

template<class SourceClass>
class ParsedTools::Proxy< SourceClass >

A proxy ParameterAcceptor wrapper for classes that have a member function add_parameters, which takes a ParameterHandler as argument, and use the ParameterHandler::add_parameter() method to add parameters.

Definition at line 32 of file proxy.h.

Constructor & Destructor Documentation

Proxy()

template<class SourceClass >

template<typename... Args>

ParsedTools::Proxy< SourceClass >::Proxy	(	const std::string &	section_name,
		Args...	args
	)

Default constructor.

The argument section_name is forwarded to the constructor of the ParameterAcceptor class, while all other arguments are passed to the SourceClass constructor.

Definition at line 46 of file proxy.h.

References ParameterAcceptor::enter_my_subsection(), ParameterAcceptor::leave_my_subsection(), and ParameterAcceptor::prm.

---

The documentation for this class was generated from the following file:

• include/parsed_tools/proxy.h