Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
IGAg_label_traits Class Reference

Traits class defining hierarchical partners' labels for immunoglobulin (IG) with an antigen (Ag). Traits class defining hierarchical partners' labels for immunoglobulin (IG) with an antigen (Ag). More...

#include <IGAg_label_traits.hpp>

Public Types

enum  Label { L_LABEL = 1 , H_LABEL = 2 , AG_LABEL = 3 , IG_LABEL = 4 }
 Enumerate the hierarchical labels in a IG-Ag complex. More...
 
typedef T_IGAg_label_traits< Dummy > Self
 

Static Public Member Functions

static unsigned get_number_of_labels (void)
 Count the number of labels, that is always 8. More...
 
static unsigned get_number_of_primitive_labels (void)
 Count the number of primitive labels, that is always 5. More...
 
static Label get_parent_of (Label label)
 IG and Ag are the roots of the hierarchy, and H1, L1, H2, L2 and Ag are the leaves of the hierarchy. More...
 
static std::string to_string (Label label)
 Return a string representing the label. More...
 

Detailed Description

Traits class defining hierarchical partners' labels for immunoglobulin (IG) with an antigen (Ag). Traits class defining hierarchical partners' labels for immunoglobulin (IG) with an antigen (Ag).

Member Typedef Documentation

◆ Self

typedef T_IGAg_label_traits<Dummy> Self
inherited

Member Enumeration Documentation

◆ Label

enum Label
inherited

Enumerate the hierarchical labels in a IG-Ag complex.

Enumerator
L_LABEL 
H_LABEL 
AG_LABEL 
IG_LABEL 

Member Function Documentation

◆ get_number_of_labels()

static unsigned get_number_of_labels ( void  )
inlinestaticinherited

Count the number of labels, that is always 8.

◆ get_number_of_primitive_labels()

static unsigned get_number_of_primitive_labels ( void  )
inlinestaticinherited

Count the number of primitive labels, that is always 5.

◆ get_parent_of()

static Label get_parent_of ( Label  label)
inlinestaticinherited

IG and Ag are the roots of the hierarchy, and H1, L1, H2, L2 and Ag are the leaves of the hierarchy.

◆ to_string()

static std::string to_string ( Label  label)
inlinestaticinherited

Return a string representing the label.