T_Particle_annotator_collector< ParticleAnnotator1, ParticleAnnotator2 > Class Template Reference

Collector for models of ParticleAnnotator. More...

#include <Particle_annotator_collector.hpp>

Public Types
typedef T_Particle_annotator_collector< ParticleAnnotator1, ParticleAnnotator2 >	Self
typedef SBL::IO::Loader_base	Base

Public Member Functions
	T_Particle_annotator_collector (void)
	~T_Particle_annotator_collector (void)
ParticleAnnotator1 &	get_first_annotator (void)
	Returns the first annotator of this collector. More...
ParticleAnnotator2 &	get_second_annotator (void)
	Returns the second annotator of this collector. More...
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. More...
bool	set_options (boost::program_options::options_description &options) const
boost::program_options::options_description	add_options (void) const
	Virtual method for adding options to the module. More...
bool	check_options (std::string &message) const
	Checks that the input options' values are coherent. More...
std::string	get_output_prefix (void) const
	Returns a prefix that concatains the input line options used when running the module. More...
bool	load (unsigned verbose, std::ostream &out)
	Loads the data. More...
std::string	get_name (void) const
	Return the name of the class itself. More...
template<class Particle >
void	operator() (Particle &p) const

Static Public Member Functions
static boost::program_options::options_description *&	get_options (void)
	Access to the options' description of the module. More...
static bool	has_options (void)
static void	delete_options (void)
static void	initialize_options (const std::string &caption)

Management
void	set_loader_instance_name (const std::string &loader_instance_name)
const std::string &	get_loader_instance_name (void) const

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 Typedef Documentation

Base

typedef SBL::IO::Loader_base Base

Self

typedef T_Particle_annotator_collector<ParticleAnnotator1, ParticleAnnotator2> Self

Constructor & Destructor Documentation

T_Particle_annotator_collector()

T_Particle_annotator_collector ( void  )

inline

~T_Particle_annotator_collector()

~T_Particle_annotator_collector ( void  )

inline

Member Function Documentation

add_options()

boost::program_options::options_description add_options ( void  ) const

inlinevirtual

Virtual method for adding options to the module.

Reimplemented from T_Module_option_description< Dummy >.

check_options()

bool check_options ( std::string &  message ) const

inlinevirtual

Checks that the input options' values are coherent.

Reimplemented from T_Module_option_description< Dummy >.

delete_options()

static void delete_options ( void  )

inlinestaticinherited

get_annotator()

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()

ParticleAnnotator1& get_first_annotator ( void  )

inline

Returns the first annotator of this collector.

get_loader_instance_name()

const std::string& get_loader_instance_name ( void  ) const

inlineinherited

get_name()

std::string get_name ( void  ) const

inlinevirtual

Return the name of the class itself.

Reimplemented from Loader_base.

get_options()

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

inlinestaticinherited

Access to the options' description of the module.

get_output_prefix()

std::string get_output_prefix ( void  ) const

inlinevirtual

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

Reimplemented from T_Module_option_description< Dummy >.

get_second_annotator()

ParticleAnnotator2& get_second_annotator ( void  )

inline

Returns the second annotator of this collector.

has_options()

static bool has_options ( void  )

inlinestaticinherited

initialize_options()

static void initialize_options ( const std::string &  caption )

inlinestaticinherited

load()

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

inlinevirtual

Loads the data.

Reimplemented from Loader_base.

operator()()

void operator() ( Particle &  p ) const

inline

set_loader_instance_name()

void set_loader_instance_name ( const std::string &  loader_instance_name )

inlineinherited

set_options()

bool set_options ( boost::program_options::options_description &  options ) const

inline