public abstract class Ion extends ExperimentObject
Modifier and Type | Class and Description |
---|---|
static class |
Ion.IonType
An enumerator of the supported ion types.
|
Modifier and Type | Field and Description |
---|---|
protected double |
theoreticMass |
protected Ion.IonType |
type
Type of ion.
|
Constructor and Description |
---|
Ion() |
Modifier and Type | Method and Description |
---|---|
static Ion |
getGenericIon(Ion.IonType ionType,
int subType)
Convenience method returning a generic ion based on the given ion type
without neutral losses.
|
static Ion |
getGenericIon(Ion.IonType ionType,
int subType,
java.util.ArrayList<NeutralLoss> neutralLosses)
Convenience method returning a generic ion based on the given ion type.
|
static java.util.ArrayList<Ion.IonType> |
getImplementedIonTypes()
Returns the implemented ion types.
|
abstract java.lang.String |
getName()
Returns the name of the ion.
|
abstract java.util.ArrayList<NeutralLoss> |
getNeutralLosses()
Returns the possible neutral losses of this ion type.
|
java.lang.String |
getNeutralLossesAsString()
Returns the neutral loss (if any), the empty string if no loss.
|
static java.lang.String |
getNeutralLossesAsString(java.util.ArrayList<NeutralLoss> neutralLosses)
Returns the neutral loss (if any), the empty string if no loss.
|
static java.util.ArrayList<java.lang.Integer> |
getPossibleSubtypes(Ion.IonType ionType)
Returns an arraylist of possible subtypes.
|
abstract CvTerm |
getPrideCvTerm()
Returns the pride cv term adapted to the fragment ion.
|
abstract int |
getSubType()
Returns the ion subtype.
|
abstract java.lang.String |
getSubTypeAsString()
Returns the subtype as string.
|
double |
getTheoreticMass()
Returns the theoretic mass.
|
double |
getTheoreticMz(int chargeValue)
Returns the theoretic m/z of an ion at a given charge state.
|
Ion.IonType |
getType()
Returns the ion type.
|
java.lang.String |
getTypeAsString()
Returns the type of ion as string.
|
static java.lang.String |
getTypeAsString(Ion.IonType type)
Returns the type of ion as string.
|
abstract boolean |
isSameAs(Ion anotherIon)
Returns a boolean indicating whether the ion is the same as another ion.
|
void |
setTheoreticMass(double theoreticMass)
Sets a new theoretic mass.
|
addUrParam, getParameterKey, getUrParam
protected Ion.IonType type
protected double theoreticMass
public abstract java.lang.String getName()
public abstract CvTerm getPrideCvTerm()
public abstract int getSubType()
public abstract java.lang.String getSubTypeAsString()
public static java.util.ArrayList<java.lang.Integer> getPossibleSubtypes(Ion.IonType ionType)
ionType
- an arraylist of possible subtypespublic abstract java.util.ArrayList<NeutralLoss> getNeutralLosses()
public abstract boolean isSameAs(Ion anotherIon)
anotherIon
- the other ionpublic java.lang.String getNeutralLossesAsString()
public static java.lang.String getNeutralLossesAsString(java.util.ArrayList<NeutralLoss> neutralLosses)
neutralLosses
- the neutral loss (if any)public double getTheoreticMass()
public double getTheoreticMz(int chargeValue)
chargeValue
- the value of the carried chargepublic void setTheoreticMass(double theoreticMass)
theoreticMass
- a new theoretic masspublic Ion.IonType getType()
public static java.util.ArrayList<Ion.IonType> getImplementedIonTypes()
public java.lang.String getTypeAsString()
public static java.lang.String getTypeAsString(Ion.IonType type)
type
- the type of ion as stringpublic static Ion getGenericIon(Ion.IonType ionType, int subType, java.util.ArrayList<NeutralLoss> neutralLosses)
ionType
- the ion typesubType
- the ion subtypeneutralLosses
- the neutral losses. An empty or null list if none.public static Ion getGenericIon(Ion.IonType ionType, int subType)
ionType
- the ion typesubType
- the ion subtypeCopyright © 2013. All Rights Reserved.