de.bioforscher.singa.structure.model.interfaces

Interface AtomContainer

All Known Subinterfaces:

AminoAcid, Chain, LeafSubstructure<FamilyType>, LeafSubstructureContainer, Ligand, Model, Nucleotide, Structure

All Known Implementing Classes:

MmtfAminoAcid, MmtfChain, MmtfLeafSubstructure, MmtfLigand, MmtfModel, MmtfNucleotide, MmtfStructure, OakAminoAcid, OakChain, OakLeafSubstructure, OakLigand, OakModel, OakNucleotide, OakStructure, StructuralMotif

public interface AtomContainer

Everything that contains Atoms.

Author:

cl

Method Summary

Modifier and Type	Method and Description
List<Atom>	getAllAtoms() Returns all Atoms.
Optional<Atom>	getAtom(Integer atomIdentifier) Returns an Optional of the Atom with the given identifier.
void	removeAtom(Integer atomIdentifier) Removes an atom from this container.

Method Detail

getAllAtoms

List<Atom> getAllAtoms()

Returns all Atoms.

Returns:

All Atoms.

getAtom

Optional<Atom> getAtom(Integer atomIdentifier)

Returns an Optional of the Atom with the given identifier. If no Atom with the identifier could be found, an empty optional is returned.

Parameters:

atomIdentifier - The identifier of the atom.

Returns:

An Optional encapsulating the Atom.

removeAtom

void removeAtom(Integer atomIdentifier)

Removes an atom from this container.

Parameters:

atomIdentifier - The identifier of the atom to be removed.