T_Alignment_residue< ResidueBase > Class Template Reference

Representation of a residue in the alignement engines Representation of a residue in the alignement engines. More...

#include "Alignment_sequence.hpp"

Public Types
typedef char	Residue_name
	1 letter code representation of a residue name.

Constructors
	T_Alignment_residue (ResidueBase &res)
	Init this residue with a base residue.

Accessors
int	residue_sequence_number (void) const
	Sequence number of the underlying residue.
char	chain_identifier (void) const
	Chain identifier of the underlying residue.
const ResidueBase &	residue (void) const
	Base residue wrapped by this DS.
Residue_name	get_name (void) const
	One letter code of this residue.
double	x (void) const
	X coordinate of the C-alpha.
double	y (void) const
	Y coordinate of the C-alpha.
double	z (void) const
	Z coordinate of the C-alpha.

I/O
template<class MolecularViewer>
static void	Molecular_view (MolecularViewer &viewer, const T_Alignment_residue< ResidueBase > &res)
	VMD and PyMOL drawing.

Detailed Description

template<class ResidueBase>
class SBL::CSB::T_Alignment_residue< ResidueBase >

Representation of a residue in the alignement engines Representation of a residue in the alignement engines.

Representation of a residue in the alignement engines.

Template Parameters

ResidueBase

Base representation of a residue, e.g from PDB / mmCIF format

Member Typedef Documentation

Residue_name

template<class ResidueBase>

typedef char Residue_name

1 letter code representation of a residue name.

Constructor & Destructor Documentation

T_Alignment_residue()

template<class ResidueBase>

T_Alignment_residue ( ResidueBase & res )

inline

Init this residue with a base residue.

Member Function Documentation

chain_identifier()

template<class ResidueBase>

char chain_identifier ( void ) const

inline

Chain identifier of the underlying residue.

get_name()

template<class ResidueBase>

Residue_name get_name ( void ) const

inline

One letter code of this residue.

Molecular_view()

template<class ResidueBase>

template<class MolecularViewer>

void Molecular_view ( MolecularViewer & viewer, const T_Alignment_residue< ResidueBase > & res )

inlinestatic

VMD and PyMOL drawing.

residue()

template<class ResidueBase>

const ResidueBase & residue ( void ) const

inline

Base residue wrapped by this DS.

residue_sequence_number()

template<class ResidueBase>

int residue_sequence_number ( void ) const

inline

Sequence number of the underlying residue.

x()

template<class ResidueBase>

double x ( void ) const

inline

X coordinate of the C-alpha.

y()

template<class ResidueBase>

double y ( void ) const

inline

Y coordinate of the C-alpha.

z()

template<class ResidueBase>

double z ( void ) const

inline

Z coordinate of the C-alpha.