T_Dynamic_annotator_for_atoms< SetDynamicAnnotation > Class Template Reference

Model of ParticleAnnotator for attributing any annotation to a particle dynamically. More...

#include <Dynamic_annotator_for_atoms.hpp>

Classes
class	T_Annotations_with_dynamic
	Default class for representing dynamic annotations (it refines a base class of annotations) More...
class	T_Annotations_with_dynamic< void, DynamicAnnotation >
	Default class for representing dynamic annotations (it is a base class of annotations) More...

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

Requirements of Loader
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.

Detailed Description

template<class SetDynamicAnnotation = Set_dynamic_annotation_default>
class SBL::Models::T_Dynamic_annotator_for_atoms< SetDynamicAnnotation >

Model of ParticleAnnotator for attributing any annotation to a particle dynamically.

Member Function Documentation

add_options()

template<class SetDynamicAnnotation>

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 SetDynamicAnnotation>

bool check_options ( std::string & message ) const

inlineoverridevirtual

Checks that the input options' values are coherent.

Reimplemented from T_Module_option_description< Dummy >.

get_name()

template<class SetDynamicAnnotation>

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 SetDynamicAnnotation>

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 >.

load()

template<class SetDynamicAnnotation>

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.