![]() |
Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
|
Model of ParticleAnnotator for attributing any annotation to a particle. More...
#include <Generic_annotator.hpp>
Public Types | |
typedef T_Generic_annotator< KeyType, AnnotationType, MakeKey, SetAnnotation, GetOptionName, GetOptionHelp, GetOptionDisplayName > | Self |
typedef SBL::IO::Loader_base | Base |
Public Member Functions | |
T_Generic_annotator (void) | |
~T_Generic_annotator (void) | |
SetAnnotation & | get_annotations_setter (void) |
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... | |
Base * | get_annotator (const std::string &name) |
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 |
Model of ParticleAnnotator for attributing any annotation to a particle.
It loads the annotations from a file into a map: the format of the file should be, at each line, the key foloowing by the annotation. The key should be a loadable value that alows a given particle to recognize its annotation.
KeyType | Type of the key of an annotation. |
AnnotationType | Type of the annotation. |
MakeKey | Functor taking a particle as input and returning its key. |
SetAnnotation | Functor taking a particle and its annotation as input and setting the annotation of the particle. |
typedef SBL::IO::Loader_base Base |
typedef T_Generic_annotator<KeyType, AnnotationType, MakeKey, SetAnnotation, GetOptionName, GetOptionHelp, GetOptionDisplayName> Self |
|
inline |
|
inline |
|
inlinevirtual |
Virtual method for adding options to the module.
Reimplemented from T_Module_option_description< Dummy >.
|
inlinevirtual |
Checks that the input options' values are coherent.
Reimplemented from T_Module_option_description< Dummy >.
|
inlinestaticinherited |
|
inline |
|
inline |
|
inlineinherited |
|
inlinevirtual |
Return the name of the class itself.
Reimplemented from Loader_base.
|
inlinestaticinherited |
Access to the options' description of the module.
|
inlinevirtual |
Returns a prefix that concatains the input line options used when running the module.
Reimplemented from T_Module_option_description< Dummy >.
|
inlinestaticinherited |
|
inlinestaticinherited |
|
inlinevirtual |
Loads the data.
Reimplemented from Loader_base.
|
inline |
|
inlineinherited |
|
inline |