Molecular_SS_bond< System > Class Template Reference

A class representing a SS bond between two residues. More...

#include <Molecular_SS_bond.h>

Public Member Functions
const int &	index () const
	Get the value of index *.
int &	index ()
	Set the value of index *.
const std::string &	first_residue_name () const
	Get the value of first_residue_name *.
std::string &	first_residue_name ()
	Set the value of first_residue_name *.
const char &	first_residue_chain () const
	Get the value of first_residue_chain *.
char &	first_residue_chain ()
	Set the value of first_residue_chain *.
const int &	first_residue_id () const
	Get the value of first_residue_id *.
int &	first_residue_id ()
	Set the value of first_residue_id *.
const char &	first_residue_inscode () const
	Get the value of first_residue_inscode *.
char &	first_residue_inscode ()
	Set the value of first_residue_inscode *.
const std::string &	second_residue_name () const
	Get the value of second_residue_name *.
std::string &	second_residue_name ()
	Set the value of second_residue_name *.
const char &	second_residue_chain () const
	Get the value of second_residue_chain *.
char &	second_residue_chain ()
	Set the value of second_residue_chain *.
const int &	second_residue_id () const
	Get the value of second_residue_id *.
int &	second_residue_id ()
	Set the value of second_residue_id *.
const char &	second_residue_inscode () const
	Get the value of second_residue_inscode *.
char &	second_residue_inscode ()
	Set the value of second_residue_inscode *.
Chain &	get_first_chain (int model=1)
Chain &	get_second_chain (int model=1)
Residue &	get_first_residue (int model=1)
	Returns the first residue of the bond in the given model :
Residue &	get_second_residue (int model=1)
	Returns the second residue of the bond in the given model :

Detailed Description

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

A class representing a SS bond between two residues.

Template Parameters

System

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

Member Function Documentation

first_residue_chain() [1/2]

template<class System>

char & first_residue_chain ( )

inline

Set the value of first_residue_chain *.

*

Parameters

value

The new value of first_residue_chain

first_residue_chain() [2/2]

template<class System>

const char & first_residue_chain ( ) const

inline

Get the value of first_residue_chain *.

• Returns

  The value of first_residue_chain

first_residue_id() [1/2]

template<class System>

int & first_residue_id ( )

inline

Set the value of first_residue_id *.

*

Parameters

value

The new value of first_residue_id

first_residue_id() [2/2]

template<class System>

const int & first_residue_id ( ) const

inline

Get the value of first_residue_id *.

• Returns

  The value of first_residue_id

first_residue_inscode() [1/2]

template<class System>

char & first_residue_inscode ( )

inline

Set the value of first_residue_inscode *.

*

Parameters

value

The new value of first_residue_inscode

first_residue_inscode() [2/2]

template<class System>

const char & first_residue_inscode ( ) const

inline

Get the value of first_residue_inscode *.

• Returns

  The value of first_residue_inscode

first_residue_name() [1/2]

template<class System>

std::string & first_residue_name ( )

inline

Set the value of first_residue_name *.

*

Parameters

value

The new value of first_residue_name

first_residue_name() [2/2]

template<class System>

const std::string & first_residue_name ( ) const

inline

Get the value of first_residue_name *.

• Returns

  The value of first_residue_name

get_first_chain()

template<class System>

Chain & get_first_chain ( int model = 1 )

inline

Returns the chain of the first residue of the bond in the given model :

get_first_residue()

template<class System>

Residue & get_first_residue ( int model = 1 )

inline

Returns the first residue of the bond in the given model :

get_second_chain()

template<class System>

Chain & get_second_chain ( int model = 1 )

inline

Returns the chain of the second residue of the bond in the given model :

get_second_residue()

template<class System>

Residue & get_second_residue ( int model = 1 )

inline

Returns the second residue of the bond in the given model :

index() [1/2]

template<class System>

int & index ( )

inline

Set the value of index *.

*

Parameters

value

The new value of index

index() [2/2]

template<class System>

const int & index ( ) const

inline

Get the value of index *.

• Returns

  The value of index

second_residue_chain() [1/2]

template<class System>

char & second_residue_chain ( )

inline

Set the value of second_residue_chain *.

*

Parameters

value

The new value of second_residue_chain

second_residue_chain() [2/2]

template<class System>

const char & second_residue_chain ( ) const

inline

Get the value of second_residue_chain *.

• Returns

  The value of second_residue_chain

second_residue_id() [1/2]

template<class System>

int & second_residue_id ( )

inline

Set the value of second_residue_id *.

*

Parameters

value

The new value of second_residue_id

second_residue_id() [2/2]

template<class System>

const int & second_residue_id ( ) const

inline

Get the value of second_residue_id *.

• Returns

  The value of second_residue_id

second_residue_inscode() [1/2]

template<class System>

char & second_residue_inscode ( )

inline

Set the value of second_residue_inscode *.

*

Parameters

value

The new value of second_residue_inscode

second_residue_inscode() [2/2]

template<class System>

const char & second_residue_inscode ( ) const

inline

Get the value of second_residue_inscode *.

• Returns

  The value of second_residue_inscode

second_residue_name() [1/2]

template<class System>

std::string & second_residue_name ( )

inline

Set the value of second_residue_name *.

*

Parameters

value

The new value of second_residue_name

second_residue_name() [2/2]

template<class System>

const std::string & second_residue_name ( ) const

inline

Get the value of second_residue_name *.

• Returns

  The value of second_residue_name