ResNum Class Reference

#include <residue_prop.hh>

Inherits additive< ResNum, int, boost::additive< ResNum, boost::totally_ordered< ResNum, boost::totally_ordered< ResNum, int, boost::unit_steppable< ResNum > > > > >.

Public Member Functions
	ResNum ()
	ResNum (int n)
	ResNum (int n, char a)
bool	operator== (const ResNum &r) const
bool	operator< (const ResNum &r) const
int	operator+= (int i)
int	operator-= (int i)
int	operator+= (const ResNum &r)
int	operator-= (const ResNum &r)
ResNum &	operator++ ()
ResNum &	operator-- ()
ResNum	NextInsertionCode () const
String	AsString () const
int	GetNum () const
void	SetNum (int num)
void	SetInsCode (char ins_code)
char	GetInsCode () const

Detailed Description

Definition at line 30 of file residue_prop.hh.

Constructor & Destructor Documentation

ResNum() [1/3]

ResNum ( )

inline

Definition at line 40 of file residue_prop.hh.

ResNum() [2/3]

ResNum ( int  n )

inline

Definition at line 44 of file residue_prop.hh.

ResNum() [3/3]

ResNum ( int  n, char  a  )

inline

Definition at line 48 of file residue_prop.hh.

Member Function Documentation

AsString()

String AsString ( ) const

inline

get residue number as String

The returned String consists of both the numeric residue sequence number and the insertion code. If the insertion code is not defined, i.e. is equal to the null character, only the residue sequence number is returned.

Definition at line 136 of file residue_prop.hh.

GetInsCode()

char GetInsCode ( ) const

inline

Definition at line 118 of file residue_prop.hh.

GetNum()

int GetNum ( ) const

inline

Definition at line 112 of file residue_prop.hh.

NextInsertionCode()

ResNum NextInsertionCode ( ) const

inline

Definition at line 98 of file residue_prop.hh.

operator++()

ResNum& operator++ ( )

inline

Definition at line 86 of file residue_prop.hh.

operator+=() [1/2]

int operator+= ( const ResNum &  r )

inline

Definition at line 74 of file residue_prop.hh.

operator+=() [2/2]

int operator+= ( int  i )

inline

Definition at line 62 of file residue_prop.hh.

operator--()

ResNum& operator-- ( )

inline

Definition at line 92 of file residue_prop.hh.

operator-=() [1/2]

int operator-= ( const ResNum &  r )

inline

Definition at line 80 of file residue_prop.hh.

operator-=() [2/2]

int operator-= ( int  i )

inline

Definition at line 68 of file residue_prop.hh.

operator<()

bool operator< ( const ResNum &  r ) const

inline

Definition at line 57 of file residue_prop.hh.

operator==()

bool operator== ( const ResNum &  r ) const

inline

Definition at line 52 of file residue_prop.hh.

SetInsCode()

void SetInsCode ( char  ins_code )

inline

Definition at line 116 of file residue_prop.hh.

SetNum()

void SetNum ( int  num )

inline

Definition at line 114 of file residue_prop.hh.

---

The documentation for this class was generated from the following file:

• build-2.9.0-doc/stage/include/ost/mol/residue_prop.hh