Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
T_Primitive_labels_loader< PartnerLabelsTraits, MediatorLabelsTraits, ExtraLabelsTraits > Class Template Reference

Loader for systems' labels specification. More...

#include "Primitive_labels_loader.hpp"

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
 

Other Types

typedef PartnerLabelsTraits::Primitive_label_classifier Primitive_partner_classifier
 Functor checking that a particle is in a partner, and returns the corresponding label if it is. More...
 
typedef MediatorLabelsTraits::Primitive_label_classifier Primitive_mediator_classifier
 Functor checking that a particle is in a mediator, and returns the corresponding label if it is. More...
 
typedef ExtraLabelsTraits::Primitive_label_classifier Primitive_extra_classifier
 Functor checking that a particle is in an extra, and returns the corresponding label if it is. More...
 

Accessors

const Primitive_partner_classifierget_partner_classifier (void) const
 Classifier for the partners (const). More...
 
Primitive_partner_classifierget_partner_classifier (void)
 Classifier for the partners. More...
 
const Primitive_mediator_classifierget_mediator_classifier (void) const
 Classifier for the mediators (const). More...
 
Primitive_mediator_classifierget_mediator_classifier (void)
 Classifier for the mediators. More...
 
const Primitive_extra_classifierget_extra_classifier (void) const
 Classifier for the extra (const). More...
 
Primitive_extra_classifierget_extra_classifier (void)
 Classifier for the extra. More...
 

Mandatory Requirements

bool load (unsigned verbose, std::ostream &out)
 Loads the data. 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...
 
std::string get_name (void) const
 Return the name of the class itself. More...
 

Optional Requirements

boost::program_options::options_description add_options (void) const
 Virtual method for adding options to the module. More...
 

Detailed Description

template<class PartnerLabelsTraits, class MediatorLabelsTraits = SBL::Models::No_label_traits, class ExtraLabelsTraits = SBL::Models::Extra_label_traits>
class SBL::IO::T_Primitive_labels_loader< PartnerLabelsTraits, MediatorLabelsTraits, ExtraLabelsTraits >

Loader for systems' labels specification.

The molecular systems's labels are defined by the concept MolecularSystemLabelsTraits. That is, a model of MolecularSystemLabelsTraits defines the type System_label which enumerates all the different labels of one category (partners or mediators or extras). A model of MolecularSystemLabelsTraits describing the partners (resp. mediators or extras) is said to follows the PartnerLabelsTraits concept (resp. MediatorLabelsTraits or ExtraLabelsTraits concept).

This loader allows to load the specifications for each label's category.

Template Parameters
PartnerLabelsTraitsTraits class defining the partners' labels hierarchy.
MediatorLabelsTraitsTraits class defining the mediators' labels hierarchy (by default, it is SBL::Models::No_label_traits).
ExtraLabelsTraitsTraits class defining the extras' labels hierarchy (by default, it is SBL::Models::No_label_traits).

Member Typedef Documentation

◆ Primitive_extra_classifier

typedef ExtraLabelsTraits::Primitive_label_classifier Primitive_extra_classifier

Functor checking that a particle is in an extra, and returns the corresponding label if it is.

◆ Primitive_mediator_classifier

typedef MediatorLabelsTraits::Primitive_label_classifier Primitive_mediator_classifier

Functor checking that a particle is in a mediator, and returns the corresponding label if it is.

◆ Primitive_partner_classifier

typedef PartnerLabelsTraits::Primitive_label_classifier Primitive_partner_classifier

Functor checking that a particle is in a partner, and returns the corresponding label if it is.

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

◆ check_options()

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

Checks that the input options' values are coherent.

Reimplemented from T_Module_option_description<>.

◆ get_extra_classifier() [1/2]

const T_Primitive_labels_loader< PartnerLabelsTraits, MediatorLabelsTraits, ExtraLabelsTraits >::Primitive_extra_classifier & get_extra_classifier ( void  ) const
inline

Classifier for the extra (const).

◆ get_extra_classifier() [2/2]

T_Primitive_labels_loader< PartnerLabelsTraits, MediatorLabelsTraits, ExtraLabelsTraits >::Primitive_extra_classifier & get_extra_classifier ( void  )
inline

Classifier for the extra.

◆ get_mediator_classifier() [1/2]

const T_Primitive_labels_loader< PartnerLabelsTraits, MediatorLabelsTraits, ExtraLabelsTraits >::Primitive_mediator_classifier & get_mediator_classifier ( void  ) const
inline

Classifier for the mediators (const).

◆ get_mediator_classifier() [2/2]

T_Primitive_labels_loader< PartnerLabelsTraits, MediatorLabelsTraits, ExtraLabelsTraits >::Primitive_mediator_classifier & get_mediator_classifier ( void  )
inline

Classifier for the mediators.

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

◆ get_partner_classifier() [1/2]

const T_Primitive_labels_loader< PartnerLabelsTraits, MediatorLabelsTraits, ExtraLabelsTraits >::Primitive_partner_classifier & get_partner_classifier ( void  ) const
inline

Classifier for the partners (const).

◆ get_partner_classifier() [2/2]

T_Primitive_labels_loader< PartnerLabelsTraits, MediatorLabelsTraits, ExtraLabelsTraits >::Primitive_partner_classifier & get_partner_classifier ( void  )
inline

Classifier for the partners.

◆ load()

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

Loads the data.

Reimplemented from Loader_base.