Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
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  Dynamic_annotation
 
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...
 

Public Types

enum  Key_element_type {
  CHAIN_TYPE = 2 , RES_NAME_TYPE = 3 , RES_ID_TYPE = 5 , ATOM_NAME_TYPE = 7 ,
  ATOM_ID_TYPE = 11 , ELEMENT_TYPE = 13
}
 
typedef T_Dynamic_annotator_for_atoms< SetDynamicAnnotation > Self
 
typedef SBL::IO::Loader_base Base
 
typedef unsigned Key_type
 

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)
 

Constructor / Destructor

 T_Dynamic_annotator_for_atoms (void)
 
 ~T_Dynamic_annotator_for_atoms (void)
 

Requirements of Loader

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...
 
std::string get_name (void) const
 Return the name of the class itself. More...
 

Functor

template<class Particle >
void operator() (Particle &p) const
 
Baseget_annotator (const std::string &name)
 

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 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 Typedef Documentation

◆ Base

◆ Key_type

typedef unsigned Key_type

◆ Self

typedef T_Dynamic_annotator_for_atoms<SetDynamicAnnotation> Self

Member Enumeration Documentation

◆ Key_element_type

Enumerator
CHAIN_TYPE 
RES_NAME_TYPE 
RES_ID_TYPE 
ATOM_NAME_TYPE 
ATOM_ID_TYPE 
ELEMENT_TYPE 

Constructor & Destructor Documentation

◆ T_Dynamic_annotator_for_atoms()

T_Dynamic_annotator_for_atoms ( void  )
inline

◆ ~T_Dynamic_annotator_for_atoms()

~T_Dynamic_annotator_for_atoms ( void  )
inline

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

◆ 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_annotator()

T_Dynamic_annotator_for_atoms< SetDynamicAnnotation >::Base * get_annotator ( const std::string &  name)
inline

◆ 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

◆ 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