io.github.msdk.datamodel

Class SimpleIonType

java.lang.Object

io.github.msdk.datamodel.SimpleIonType

All Implemented Interfaces:

IonType

public class SimpleIonType
extends Object
implements IonType

Implementation of IonType

Constructor Summary

Constructors

Constructor and Description
SimpleIonType(String name, PolarityType polarity, int numberOfMolecules, String adductFormula, Integer charge) Constructor for SimpleIonType.

Method Summary

Modifier and Type	Method and Description
String	getAdductFormula() getAdductFormula.
Integer	getCharge() getCharge.
String	getName() getName.
int	getNumberOfMolecules() getNumberOfMolecules.
PolarityType	getPolarity() getPolarity.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleIonType

public SimpleIonType(@Nonnull
                     String name,
                     @Nonnull
                     PolarityType polarity,
                     int numberOfMolecules,
                     @Nonnull
                     String adductFormula,
                     Integer charge)

Constructor for SimpleIonType.

Parameters:

name - a String object.

polarity - a PolarityType object.

numberOfMolecules - a int.

adductFormula - a String object.

charge - a Integer object.

Method Detail

getName

@Nonnull
public String getName()

getName.

Specified by:

getName in interface IonType

Returns:

Name of ionization type, such as [M+2H]2+.

getPolarity

@Nonnull
public PolarityType getPolarity()

getPolarity.

Specified by:

getPolarity in interface IonType

Returns:

Polarity of ionization. See #PolarityType.java for values.

getNumberOfMolecules

public int getNumberOfMolecules()

getNumberOfMolecules.

Specified by:

getNumberOfMolecules in interface IonType

Returns:

Number of molecules in this ion.

getAdductFormula

@Nonnull
public String getAdductFormula()

getAdductFormula.

Specified by:

getAdductFormula in interface IonType

Returns:

Chemical formula for adduct.

getCharge

public Integer getCharge()

getCharge.

Specified by:

getCharge in interface IonType

Returns:

Charge of ion.