Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
T_Tricolor_interface_data_structure_base< MolecularInterfaceDataStructure > Class Template Reference

Container defining what is a tricolor interface between two partners. More...

#include <Tricolor_interface_data_structure.hpp>

Public Types

typedef T_Tricolor_interface_data_structure_base< MolecularInterfaceDataStructure > Self
 
typedef MolecularInterfaceDataStructure Base
 

Public Types

typedef Base::Partner_labels_traits Partner_labels_traits
 Traits class defining types related to labels of partners. More...
 
typedef Base::Partner_label Partner_label
 System's label associated to a partner. More...
 
typedef Base::Mediator_labels_traits Mediator_labels_traits
 Traits class defining types related to labels of partners. More...
 
typedef Base::Mediator_label Mediator_label
 System's label associated to a partner. More...
 

Constructors

 T_Tricolor_interface_data_structure_base (Partner_label partner_1, Partner_label partner_2, Mediator_label mediator)
 Constructor for empty tricolor interface. More...
 
template<class InputIterator , class MolecularStructureClassifier >
 T_Tricolor_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 tricolor 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 (order is arbitrary set). More...
 

Detailed Description

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

Container defining what is a tricolor interface between two partners.

Template Parameters
MolecularInterfaceDataStructureIt can be either a model of CSB::T_Molecular_interface_connected_component or CSB::T_Molecular_interface.

Member Typedef Documentation

◆ Base

typedef MolecularInterfaceDataStructure Base

◆ Mediator_label

typedef Base::Mediator_label Mediator_label

System's label associated to a partner.

◆ Mediator_labels_traits

typedef Base::Mediator_labels_traits Mediator_labels_traits

Traits class defining types related to labels of partners.

◆ 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 defining types related to labels of partners.

◆ Self

typedef T_Tricolor_interface_data_structure_base<MolecularInterfaceDataStructure> Self

Constructor & Destructor Documentation

◆ T_Tricolor_interface_data_structure_base() [1/2]

T_Tricolor_interface_data_structure_base ( Partner_label  partner_1,
Partner_label  partner_2,
Mediator_label  mediator 
)
inline

Constructor for empty tricolor interface.

◆ T_Tricolor_interface_data_structure_base() [2/2]

T_Tricolor_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 tricolor edges in between [begin, end).

Member Function Documentation

◆ get_first_partner()

T_Tricolor_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_Tricolor_interface_data_structure_base< MolecularInterfaceDataStructure >::Mediator_label get_mediator ( void  ) const
inline

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

◆ get_second_partner()

T_Tricolor_interface_data_structure_base< MolecularInterfaceDataStructure >::Partner_label get_second_partner ( void  ) const
inline

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