T_Mediated_interface_data_structure_base< MolecularInterfaceDataStructure > Class Template Reference

Container defining what is a mediated interface between two partners and a mediator. More...

#include <Mediated_interface_data_structure.hpp>

Public Types
typedef Base::Partner_labels_traits	Partner_labels_traits
	Traits class providing the labels for the partners. More...
typedef Base::Mediator_labels_traits	Mediator_labels_traits
	Traits class providing the labels for the mediators. More...
typedef Base::Partner_label	Partner_label
	System's label associated to a partner. More...
typedef Base::Mediator_label	Mediator_label
	System's label associated to a mediator. More...

Constructors
	T_Mediated_interface_data_structure_base (Partner_label partner_1, Partner_label partner_2, Mediator_label mediator)
	Constructor for empty mediated interface. More...
template<class InputIterator , class MolecularStructureClassifier >
	T_Mediated_interface_data_structure_base (Partner_label partner_1, Partner_label partner_2, Mediator_label mediator, InputIterator begin, InputIterator end, MolecularStructureClassifier &classifier)
	Constructor initialized with all mediated edges in between [begin, end). More...

Accessors
Partner_label	get_first_partner (void) const
	Accessing the first partner's label (order is arbitrary set). More...
Partner_label	get_second_partner (void) const
	Accessing the second partner's label (order is arbitrary set). More...
Mediator_label	get_mediator (void) const
	Accessing the mediator's label. More...

Detailed Description

template<class MolecularInterfaceDataStructure>
class SBL::CSB::T_Mediated_interface_data_structure_base< MolecularInterfaceDataStructure >

Container defining what is a mediated interface between two partners and a mediator.

Template Parameters

MolecularInterfaceDataStructure

It can be either a model of CSB::T_Molecular_interface_connected_component or CSB::T_Molecular_interface.

Member Typedef Documentation

Mediator_label

typedef Base::Mediator_label Mediator_label

System's label associated to a mediator.

Mediator_labels_traits

typedef Base::Mediator_labels_traits Mediator_labels_traits

Traits class providing the labels for the mediators.

Partner_label

typedef Base::Partner_label Partner_label

System's label associated to a partner.

Partner_labels_traits

typedef Base::Partner_labels_traits Partner_labels_traits

Traits class providing the labels for the partners.

Constructor & Destructor Documentation

T_Mediated_interface_data_structure_base() [1/2]

T_Mediated_interface_data_structure_base ( Partner_label  partner_1, Partner_label  partner_2, Mediator_label  mediator  )

inline

Constructor for empty mediated interface.

T_Mediated_interface_data_structure_base() [2/2]

T_Mediated_interface_data_structure_base ( Partner_label  partner_1, Partner_label  partner_2, Mediator_label  mediator, InputIterator  begin, InputIterator  end, MolecularStructureClassifier &  classifier  )

inline

Constructor initialized with all mediated edges in between [begin, end).

Member Function Documentation

get_first_partner()

T_Mediated_interface_data_structure_base< MolecularInterfaceDataStructure >::Partner_label get_first_partner ( void  ) const

inline

Accessing the first partner's label (order is arbitrary set).

get_mediator()

T_Mediated_interface_data_structure_base< MolecularInterfaceDataStructure >::Mediator_label get_mediator ( void  ) const

inline

Accessing the mediator's label.

get_second_partner()

T_Mediated_interface_data_structure_base< MolecularInterfaceDataStructure >::Partner_label get_second_partner ( void  ) const

inline

Accessing the second partner's label (order is arbitrary set).