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

Model of Particle with a system's label. More...

#include <Particle_with_system_label_traits.hpp>

Classes

union  System_label
 Representation of a system's label, that can be either a partner, a mediator or an extra label. More...

Public Types

typedef PartnerLabelsTraits Partner_labels_traits
 Model of MolecularSystemLabelsTraits for partners' labels.
typedef MediatorLabelsTraits Mediator_labels_traits
 Model of MolecularSystemLabelsTraits for mediators' labels.
typedef ExtraLabelsTraits Extra_labels_traits
 Model of MolecularSystemLabelsTraits for extra labels.
typedef PartnerLabelsTraits::Label Partner_label
 Representation of a partner's label.
typedef PartnerLabelsTraits::Primitive_label_classifier Primitive_partner_classifier
 Classification of the primitive partners.
typedef MediatorLabelsTraits::Label Mediator_label
 Representation of a mediator's label.
typedef MediatorLabelsTraits::Primitive_label_classifier Primitive_mediator_classifier
 Classification of the primitive mediators.
typedef ExtraLabelsTraits::Label Extra_label
 Representation of an extra's label.
typedef ExtraLabelsTraits::Primitive_label_classifier Primitive_extra_classifier
 Classification of the primitive extras.

Labels Management

bool set_system_label (const Primitive_partner_classifier &partner_classifier=Primitive_partner_classifier(), const Primitive_mediator_classifier &mediator_classifier=Primitive_mediator_classifier(), const Primitive_extra_classifier &extra_classifier=Primitive_extra_classifier())
 Updates the system's label of this particle using the input classifiers of primitive labels.

Detailed Description

template<class ParticleBase, class PartnerLabelsTraits, class MediatorLabelsTraits, class ExtraLabelsTraits, bool IsSerializedLabel>
class SBL::Models::T_Particle_with_system_label< ParticleBase, PartnerLabelsTraits, MediatorLabelsTraits, ExtraLabelsTraits, IsSerializedLabel >

Model of Particle with a system's label.

...

Template Parameters
ParticleBaseBase model of ParticleTraits.
PartnerLabelsTraitsModel of MolecularSystemLabelsTraits for partners' labels.
MediatorLabelsTraitsModel of MolecularSystemLabelsTraits for mediators' labels.
ExtraLabelsTraitsModel of MolecularSystemLabelsTraits for extra labels.
IsSerializedLabelBoolean that checks that the labels are serialized in the output (default is true).

Class Documentation

◆ SBL::Models::T_Particle_with_system_label::System_label

union SBL::Models::T_Particle_with_system_label::System_label
template<class ParticleBase, class PartnerLabelsTraits, class MediatorLabelsTraits, class ExtraLabelsTraits, bool IsSerializedLabel>
union SBL::Models::T_Particle_with_system_label< ParticleBase, PartnerLabelsTraits, MediatorLabelsTraits, ExtraLabelsTraits, IsSerializedLabel >::System_label

Representation of a system's label, that can be either a partner, a mediator or an extra label.

Member Typedef Documentation

◆ Extra_label

template<class ParticleBase, class PartnerLabelsTraits, class MediatorLabelsTraits, class ExtraLabelsTraits, bool IsSerializedLabel>
typedef ExtraLabelsTraits::Label Extra_label

Representation of an extra's label.

◆ Extra_labels_traits

template<class ParticleBase, class PartnerLabelsTraits, class MediatorLabelsTraits, class ExtraLabelsTraits, bool IsSerializedLabel>
typedef ExtraLabelsTraits Extra_labels_traits

Model of MolecularSystemLabelsTraits for extra labels.

◆ Mediator_label

template<class ParticleBase, class PartnerLabelsTraits, class MediatorLabelsTraits, class ExtraLabelsTraits, bool IsSerializedLabel>
typedef MediatorLabelsTraits::Label Mediator_label

Representation of a mediator's label.

◆ Mediator_labels_traits

template<class ParticleBase, class PartnerLabelsTraits, class MediatorLabelsTraits, class ExtraLabelsTraits, bool IsSerializedLabel>
typedef MediatorLabelsTraits Mediator_labels_traits

Model of MolecularSystemLabelsTraits for mediators' labels.

◆ Partner_label

template<class ParticleBase, class PartnerLabelsTraits, class MediatorLabelsTraits, class ExtraLabelsTraits, bool IsSerializedLabel>
typedef PartnerLabelsTraits::Label Partner_label

Representation of a partner's label.

◆ Partner_labels_traits

template<class ParticleBase, class PartnerLabelsTraits, class MediatorLabelsTraits, class ExtraLabelsTraits, bool IsSerializedLabel>
typedef PartnerLabelsTraits Partner_labels_traits

Model of MolecularSystemLabelsTraits for partners' labels.

◆ Primitive_extra_classifier

template<class ParticleBase, class PartnerLabelsTraits, class MediatorLabelsTraits, class ExtraLabelsTraits, bool IsSerializedLabel>
typedef ExtraLabelsTraits::Primitive_label_classifier Primitive_extra_classifier

Classification of the primitive extras.

◆ Primitive_mediator_classifier

template<class ParticleBase, class PartnerLabelsTraits, class MediatorLabelsTraits, class ExtraLabelsTraits, bool IsSerializedLabel>
typedef MediatorLabelsTraits::Primitive_label_classifier Primitive_mediator_classifier

Classification of the primitive mediators.

◆ Primitive_partner_classifier

template<class ParticleBase, class PartnerLabelsTraits, class MediatorLabelsTraits, class ExtraLabelsTraits, bool IsSerializedLabel>
typedef PartnerLabelsTraits::Primitive_label_classifier Primitive_partner_classifier

Classification of the primitive partners.

Member Function Documentation

◆ set_system_label()

template<class ParticleBase, class PartnerLabelsTraits, class MediatorLabelsTraits, class ExtraLabelsTraits, bool IsSerializedLabel>
bool set_system_label ( const Primitive_partner_classifier & partner_classifier = Primitive_partner_classifier(),
const Primitive_mediator_classifier & mediator_classifier = Primitive_mediator_classifier(),
const Primitive_extra_classifier & extra_classifier = Primitive_extra_classifier() )
inline

Updates the system's label of this particle using the input classifiers of primitive labels.