Molecular_residue< System > Class Template Reference

A class representing a molecular residue. More...

#include <Molecular_residue.h>

Public Member Functions
const std::string &	residue_name () const
	Get the value of residue_name *.
std::string &	residue_name ()
	Set the value of residue_name *.
const int &	residue_sequence_number () const
	Get the value of residue_sequence_number *.
int &	residue_sequence_number ()
	Set the value of residue_sequence_number *.
const char &	insertion_code () const
	Get the value of insertion_code *.
char &	insertion_code ()
	Set the value of insertion_code *.

Detailed Description

template<class System>
class SBL::CSB::Molecular_residue< System >

A class representing a molecular residue.

Template Parameters

System

The class representing a molecular system, providing the type definitions for its various components

Member Function Documentation

insertion_code() [1/2]

template<class System>

char & insertion_code ( )

inline

Set the value of insertion_code *.

*

Parameters

value

The new value of insertion_code

insertion_code() [2/2]

template<class System>

const char & insertion_code ( ) const

inline

Get the value of insertion_code *.

• Returns

  The value of insertion_code

residue_name() [1/2]

template<class System>

std::string & residue_name ( )

inline

Set the value of residue_name *.

*

Parameters

value

The new value of residue_name

residue_name() [2/2]

template<class System>

const std::string & residue_name ( ) const

inline

Get the value of residue_name *.

• Returns

  The value of residue_name

residue_sequence_number() [1/2]

template<class System>

int & residue_sequence_number ( )

inline

Set the value of residue_sequence_number *.

*

Parameters

value

The new value of residue_sequence_number

residue_sequence_number() [2/2]

template<class System>

const int & residue_sequence_number ( ) const

inline

Get the value of residue_sequence_number *.

• Returns

  The value of residue_sequence_number