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 T_Particle_with_system_label< ParticleBase, PartnerLabelsTraits, MediatorLabelsTraits, ExtraLabelsTraits, IsSerializedLabel >	Self
typedef ParticleBase	Base
typedef PartnerLabelsTraits	Partner_labels_traits
	Model of MolecularSystemLabelsTraits for partners' labels. More...
typedef MediatorLabelsTraits	Mediator_labels_traits
	Model of MolecularSystemLabelsTraits for mediators' labels. More...
typedef ExtraLabelsTraits	Extra_labels_traits
	Model of MolecularSystemLabelsTraits for extra labels. More...
typedef PartnerLabelsTraits::Label	Partner_label
	Representation of a partner's label. More...
typedef PartnerLabelsTraits::Primitive_label_classifier	Primitive_partner_classifier
	Classification of the primitive partners. More...
typedef MediatorLabelsTraits::Label	Mediator_label
	Representation of a mediator's label. More...
typedef MediatorLabelsTraits::Primitive_label_classifier	Primitive_mediator_classifier
	Classification of the primitive mediators. More...
typedef ExtraLabelsTraits::Label	Extra_label
	Representation of an extra's label. More...
typedef ExtraLabelsTraits::Primitive_label_classifier	Primitive_extra_classifier
	Classification of the primitive extras. More...

Public Member Functions
	T_Particle_with_system_label (void)
	T_Particle_with_system_label (const Self &particle)
	T_Particle_with_system_label (const Base &particle)
template<class Particle >
	T_Particle_with_system_label (const Particle &particle)
template<class Archive >
void	serialize (Archive &ar, const unsigned int file_version)

Labels Management
bool	is_partner (void) const
bool	is_mediator (void) const
bool	is_extra (void) const
Partner_label	get_partner_label (void) const
Mediator_label	get_mediator_label (void) const
Extra_label	get_extra_label (void) const
void	set_partner_label (Partner_label label)
void	set_mediator_label (Mediator_label label)
void	set_extra_label (Extra_label label)
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. More...

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

ParticleBase	Base model of ParticleTraits.
PartnerLabelsTraits	Model of MolecularSystemLabelsTraits for partners' labels.
MediatorLabelsTraits	Model of MolecularSystemLabelsTraits for mediators' labels.
ExtraLabelsTraits	Model of MolecularSystemLabelsTraits for extra labels.
IsSerializedLabel	Boolean 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.

Class Members
Extra_label	extra
Mediator_label	mediator
Partner_label	partner

Member Typedef Documentation

Base

typedef ParticleBase Base

Extra_label

typedef ExtraLabelsTraits::Label Extra_label

Representation of an extra's label.

Extra_labels_traits

typedef ExtraLabelsTraits Extra_labels_traits

Model of MolecularSystemLabelsTraits for extra labels.

Mediator_label

typedef MediatorLabelsTraits::Label Mediator_label

Representation of a mediator's label.

Mediator_labels_traits

typedef MediatorLabelsTraits Mediator_labels_traits

Model of MolecularSystemLabelsTraits for mediators' labels.

Partner_label

typedef PartnerLabelsTraits::Label Partner_label

Representation of a partner's label.

Partner_labels_traits

typedef PartnerLabelsTraits Partner_labels_traits

Model of MolecularSystemLabelsTraits for partners' labels.

Primitive_extra_classifier

typedef ExtraLabelsTraits:: Primitive_label_classifier Primitive_extra_classifier

Classification of the primitive extras.

Primitive_mediator_classifier

typedef MediatorLabelsTraits:: Primitive_label_classifier Primitive_mediator_classifier

Classification of the primitive mediators.

Primitive_partner_classifier

typedef PartnerLabelsTraits:: Primitive_label_classifier Primitive_partner_classifier

Classification of the primitive partners.

Self

typedef T_Particle_with_system_label<ParticleBase, PartnerLabelsTraits, MediatorLabelsTraits, ExtraLabelsTraits, IsSerializedLabel> Self

Constructor & Destructor Documentation

T_Particle_with_system_label() [1/4]

T_Particle_with_system_label ( void  )

inline

T_Particle_with_system_label() [2/4]

T_Particle_with_system_label ( const Self &  particle )

inline

T_Particle_with_system_label() [3/4]

T_Particle_with_system_label ( const Base &  particle )

inline

T_Particle_with_system_label() [4/4]

T_Particle_with_system_label ( const Particle &  particle )

inline

Member Function Documentation

get_extra_label()

Extra_label get_extra_label ( void  ) const

inline

get_mediator_label()

Mediator_label get_mediator_label ( void  ) const

inline

get_partner_label()

Partner_label get_partner_label ( void  ) const

inline

is_extra()

bool is_extra ( void  ) const

inline

is_mediator()

bool is_mediator ( void  ) const

inline

is_partner()

bool is_partner ( void  ) const

inline

serialize()

void serialize ( Archive &  ar, const unsigned int  file_version  )

inline

set_extra_label()

void set_extra_label ( Extra_label  label )

inline

set_mediator_label()

void set_mediator_label ( Mediator_label  label )

inline

set_partner_label()

void set_partner_label ( Partner_label  label )

inline

set_system_label()

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.