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

Traits class defining hierarchical partners' labels for immunoglobulin (IG). Traits class defining hierarchical partners' labels for immunoglobulin (IG). More...

#include <IG_label_traits.hpp>

Public Types

enum  Label
 Enumerate the hierarchical labels in IG. More...
 

Static Public Member Functions

static unsigned get_number_of_labels (void)
 Count the number of labels, that is always 3. More...
 
static unsigned get_number_of_primitive_labels (void)
 Count the number of primitive labels, that is always 4. More...
 
static Label get_parent_of (Label label)
 IG is the only root of the hierarchy, and H1, L1, H2, L2 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). Traits class defining hierarchical partners' labels for immunoglobulin (IG).

Member Enumeration Documentation

◆ Label

enum Label
inherited

Enumerate the hierarchical labels in IG.

Member Function Documentation

◆ get_number_of_labels()

static unsigned get_number_of_labels ( void  )
inlinestaticinherited

Count the number of labels, that is always 3.

◆ get_number_of_primitive_labels()

static unsigned get_number_of_primitive_labels ( void  )
inlinestaticinherited

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

◆ get_parent_of()

static Label get_parent_of ( Label  label)
inlinestaticinherited

IG is the only root of the hierarchy, and H1, L1, H2, L2 are the leaves of the hierarchy.

◆ to_string()

static std::string to_string ( Label  label)
inlinestaticinherited

Return a string representing the label.