Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
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. More...
 
ParticleAnnotator2 & get_second_annotator (void)
 Returns the second annotator of this collector. More...
 
Baseget_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...
 
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...
 

Static Public Member Functions

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

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
ParticleAnnotator1Annotator that will be called in first.
ParticleAnnotator2Annotator that will be called in second.

Member Function Documentation

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

Virtual method for adding options to the module.

Reimplemented from T_Module_option_description<>.

bool check_options ( std::string &  message) const
inlinevirtual

Checks that the input options' values are coherent.

Reimplemented from T_Module_option_description<>.

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.

ParticleAnnotator1& get_first_annotator ( void  )
inline

Returns the first annotator of this collector.

std::string get_name ( void  ) const
inlinevirtual

Return the name of the class itself.

Reimplemented from Loader_base.

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

Access to the options' description of the module.

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

ParticleAnnotator2& get_second_annotator ( void  )
inline

Returns the second annotator of this collector.

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

Loads the data.

Reimplemented from Loader_base.