T_Bicolor_interface_data_structure_base< MolecularInterfaceDataStructure > Class Template Reference

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

#include <Bicolor_interface_data_structure.hpp>

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

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

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

Detailed Description

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

Container defining what is a bicolor interface between two partners.

Template Parameters

MolecularInterfaceDataStructure

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

Member Typedef Documentation

Partner_label

template<class MolecularInterfaceDataStructure>

typedef Base::Partner_label Partner_label

System's label associated to a partner.

Partner_labels_traits

template<class MolecularInterfaceDataStructure>

typedef Base::Partner_labels_traits Partner_labels_traits

Traits class defining types related to labels of partners.

Constructor & Destructor Documentation

T_Bicolor_interface_data_structure_base() [1/2]

template<class MolecularInterfaceDataStructure>

T_Bicolor_interface_data_structure_base ( Partner_label partner_1, Partner_label partner_2 )

inline

Constructor for empty bicolor interface.

T_Bicolor_interface_data_structure_base() [2/2]

template<class MolecularInterfaceDataStructure>

template<class InputIterator, class MolecularStructureClassifier>

T_Bicolor_interface_data_structure_base ( Partner_label partner_1, Partner_label partner_2, InputIterator begin, InputIterator end, MolecularStructureClassifier & classifier )

inline

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

Member Function Documentation

get_first_partner()

template<class MolecularInterfaceDataStructure>

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

inline

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

get_second_partner()

template<class MolecularInterfaceDataStructure>

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

inline

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