Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
T_Domain_annotator_for_particles< Annotations > Class Template Reference

Model of ParticleAnnotator for attributing a domain to atoms. Model of ParticleAnnotator for attributing a domain to atoms. More...

#include <Domain_annotator_for_particles.hpp>

Public Types

typedef T_Domain_annotator_for_particles< Annotations > Self
 
typedef SBL::IO::Loader_base Base
 
typedef std::vector< boost::tuple< std::string, unsigned, unsigned > > Ranges_container
 

Public Member Functions

 T_Domain_annotator_for_particles (void)
 
 ~T_Domain_annotator_for_particles (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...
 
void set_current_molecule (unsigned i)
 
void add_path (std::string added_path)
 
std::string get_name (void) const
 Return the name of the class itself. More...
 
std::string operator[] (unsigned residue_sequence_number) const
 
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 Annotations>
class SBL::Models::T_Domain_annotator_for_particles< Annotations >

Model of ParticleAnnotator for attributing a domain to atoms. Model of ParticleAnnotator for attributing a domain to atoms.

Member Typedef Documentation

◆ Base

◆ Ranges_container

typedef std::vector< boost::tuple<std::string, unsigned, unsigned> > Ranges_container

◆ Self

typedef T_Domain_annotator_for_particles<Annotations> Self

Constructor & Destructor Documentation

◆ T_Domain_annotator_for_particles()

◆ ~T_Domain_annotator_for_particles()

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

◆ add_path()

void add_path ( std::string  added_path)
inline

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

◆ 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

◆ operator[]()

std::string operator[] ( unsigned  residue_sequence_number) const
inline

◆ set_current_molecule()

void set_current_molecule ( unsigned  i)
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