uk.ac.ebi.pride.utilities.iongen.model

Interface PrecursorIon

All Superinterfaces:

PeptideIon

All Known Implementing Classes:

AbstractPrecursorIon, DefaultPrecursorIon

public interface PrecursorIon
extends PeptideIon

A kind of PeptideIon, which can cleavage different types of product ions.

Version:

0.1-SNAPSHOT

Author:

Qingwei XU

See Also:

AbstractPrecursorIon

Method Summary

Methods

Modifier and Type	Method and Description
ProductIon	getProductIon(ProductIonType type, int position, int charge) A precursor ion can cleavage different type of product ions.

Methods inherited from interface uk.ac.ebi.pride.utilities.iongen.model.PeptideIon

getCharge, getMass, getMassOverCharge, getPeptide

Method Detail

getProductIon

ProductIon getProductIon(ProductIonType type,
                       int position,
                       int charge)
                         throws IonCleavageException

A precursor ion can cleavage different type of product ions.

Parameters:

type - can not set null, otherwise throw NullPointerException.

position - from [1..peptide.length-1]

charge - from [1..3], based on the precursor charge.

Returns:

ProductIon, can not return a null.

Throws:

IonCleavageException, - when user set position and charge overflow the range of setting.

IonCleavageException