T_Particle_annotator_collector< ParticleAnnotator1, ParticleAnnotator2 > Class Template Reference

Collector for models of ParticleAnnotator. More...

#include <Particle_annotator_collector.hpp>

Public Member Functions
ParticleAnnotator1 &	get_first_annotator (void)
	Returns the first annotator of this collector.
ParticleAnnotator2 &	get_second_annotator (void)
	Returns the second annotator of this collector.
Base *	get_annotator (const std::string &name)
	Returns the annotator in the collector whose instance name is the input name, or the NULL pointer if there is none.
boost::program_options::options_description	add_options (void) override
	Virtual method for adding options to the module.
bool	check_options (std::string &message) const override
	Checks that the input options' values are coherent.
std::string	get_output_prefix (void) const override
	Returns a prefix that concatains the input line options used when running the module.
bool	load (unsigned verbose, std::ostream &out) override
	Load function.
std::string	get_name (void) const override
	Return the name of the class itself.

Static Public Member Functions
static boost::program_options::options_description *&	get_options (void)
	Access to the options' description of the module.

Detailed Description

template<class ParticleAnnotator1, class ParticleAnnotator2>
class SBL::Models::T_Particle_annotator_collector< ParticleAnnotator1, ParticleAnnotator2 >

Collector for models of ParticleAnnotator.

Template Parameters

ParticleAnnotator1	Annotator that will be called in first.
ParticleAnnotator2	Annotator that will be called in second.

Member Function Documentation

add_options()

template<class ParticleAnnotator1, class ParticleAnnotator2>

boost::program_options::options_description add_options ( void )

inlineoverridevirtual

Virtual method for adding options to the module.

Reimplemented from T_Module_option_description< Dummy >.

check_options()

template<class ParticleAnnotator1, class ParticleAnnotator2>

bool check_options ( std::string & message ) const

inlineoverridevirtual

Checks that the input options' values are coherent.

Reimplemented from T_Module_option_description< Dummy >.

get_annotator()

template<class ParticleAnnotator1, class ParticleAnnotator2>

Base * get_annotator ( const std::string & name )

inline

Returns the annotator in the collector whose instance name is the input name, or the NULL pointer if there is none.

get_first_annotator()

template<class ParticleAnnotator1, class ParticleAnnotator2>

ParticleAnnotator1 & get_first_annotator ( void )

inline

Returns the first annotator of this collector.

get_name()

template<class ParticleAnnotator1, class ParticleAnnotator2>

std::string get_name ( void ) const

inlineoverridevirtual

Return the name of the class itself.

Reimplemented from Loader_base.

get_options()

template<class Dummy = void>

boost::program_options::options_description *& get_options ( void )

inlinestaticinherited

Access to the options' description of the module.

get_output_prefix()

template<class ParticleAnnotator1, class ParticleAnnotator2>

std::string get_output_prefix ( void ) const

inlineoverridevirtual

Returns a prefix that concatains the input line options used when running the module.

Reimplemented from T_Module_option_description< Dummy >.

get_second_annotator()

template<class ParticleAnnotator1, class ParticleAnnotator2>

ParticleAnnotator2 & get_second_annotator ( void )

inline

Returns the second annotator of this collector.

load()

template<class ParticleAnnotator1, class ParticleAnnotator2>

bool load ( unsigned verbose, std::ostream & out )

inlineoverridevirtual

Load function.

Parameters

	verbose	Verbosity level.
[out]	out	Output stream.

Returns

True if loading is successful, false otherwise. Function to call to execute the main function of a Loader

Reimplemented from Loader_base.