# `class pdb.ResidueBase`

Available on all platforms

base class for PDB residue (amino acids, water, lipids, ions, ...)

## Sub classes:

PdbResidue | Container of a residue in pdb file. Non-amino acid molecules such as waters, co-factors, lipids are considered as residues.

## Instance Fields

### `var index:Int`

residue index

### `var isCterm:Bool`

is a C-terminal residue?

### `var isNterm:Bool`

is an N-terminal residue?

### `var name:String`

residue name

### `function new(n:String, i:Int, isnt:Bool, isct:Bool):Void`

Constructor.

- n: residue name
- i: residue index
- isnt: is N-terminal?
- isct: is C-terminal?

### `function get_index():Int`

getter for `index`

### `function get_isCterm():Bool`

getter for `isCterm`

### `function get_isNterm():Bool`

getter for `isNterm`

### `function get_name():String`

getter for `name`

### `function set_index(i:Int):Int`

setter for `index`

### `function set_isCterm(b:Bool):Bool`

setter for `isCterm`

### `function set_isNterm(b:Bool):Bool`

setter for `isNterm`

### `function set_name(s:String):String`

setter for `name`