T_Name_annotator_for_pseudo_atoms< SetAnnotatedName > Class Template Reference

Model of ParticleAnnotator for attributing a name to a pseudo-atom. More...

#include <Name_annotator_for_pseudo_atoms.hpp>

Public Member Functions
boost::program_options::options_description	add_options (void)
	Virtual method for adding options to the module.
bool	check_options (std::string &message) const
	Checks that the input options' values are coherent.
std::string	get_output_prefix (void) const
	Returns a prefix that concatains the input line options used when running the module.
bool	load (unsigned verbose, std::ostream &out)
	Load function.
std::string	get_name (void) const
	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 SetAnnotatedName = Name_annotator_for_pseudo_atoms_setter_default>
class SBL::Models::T_Name_annotator_for_pseudo_atoms< SetAnnotatedName >

Model of ParticleAnnotator for attributing a name to a pseudo-atom.

It loads the annotations from a file without header information. In this annotator, pseudo-atoms are supposed to represent residues, so that the key of a pseudo-atom is the 3 letters code of the residue it presents. By default, the associated name is the name os the residue.

Template Parameters

SetAnnotatedName

Functor taking a particle and a name and setting the name to the particle.

Member Function Documentation

add_options()

template<class SetAnnotatedName = Name_annotator_for_pseudo_atoms_setter_default>

boost::program_options::options_description add_options ( void )

inlinevirtual

Virtual method for adding options to the module.

Reimplemented from T_Module_option_description< Dummy >.

check_options()

template<class SetAnnotatedName = Name_annotator_for_pseudo_atoms_setter_default>

bool check_options ( std::string & message ) const

inlinevirtual

Checks that the input options' values are coherent.

Reimplemented from T_Module_option_description< Dummy >.

get_name()

template<class SetAnnotatedName = Name_annotator_for_pseudo_atoms_setter_default>

std::string get_name ( void ) const

inlinevirtual

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 SetAnnotatedName = Name_annotator_for_pseudo_atoms_setter_default>

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

load()

template<class SetAnnotatedName = Name_annotator_for_pseudo_atoms_setter_default>

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

inlinevirtual

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.