Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Types | Public Member Functions | Friends

Adduct Class Reference

#include <OpenMS/DATASTRUCTURES/Adduct.h>

List of all members.

Public Types

typedef std::vector< AdductAdductsType

Public Member Functions

 Adduct ()
 Default C'tor.
 Adduct (Int charge)
 C'tor with initial charge.
 Adduct (Int charge, Int amount, DoubleReal singleMass, String formula, DoubleReal log_prob, DoubleReal rt_shift, const String label="")
 C'tor for all members.
Adduct operator* (const Int m) const
 Increase amount of this adduct by factor.
Adduct operator+ (const Adduct &rhs)
 Add two adducts amount if they are equal (defined by equal formula).
void operator+= (const Adduct &rhs)
 Add other adducts amount to *this (equal formula required!).

Friends

std::ostream & operator<< (std::ostream &os, const Adduct &a)
 Print the contents of an Adduct to a stream.
bool operator== (const Adduct &a, const Adduct &b)
 Comparator.



Int charge_
Int amount_
DoubleReal singleMass_
DoubleReal log_prob_
String formula_
DoubleReal rt_shift_
String label_
const IntgetCharge () const
void setCharge (const Int &charge)
const IntgetAmount () const
void setAmount (const Int &amount)
const DoubleRealgetSingleMass () const
void setSingleMass (const DoubleReal &singleMass)
const DoubleRealgetLogProb () const
void setLogProb (const DoubleReal &log_prob)
const StringgetFormula () const
void setFormula (const String &formula)
const DoubleRealgetRTShift () const
const StringgetLabel () const
String checkFormula_ (const String &formula)

Member Typedef Documentation

typedef std::vector<Adduct> AdductsType

Constructor & Destructor Documentation

Adduct (  ) 

Default C'tor.

Adduct ( Int  charge  ) 

C'tor with initial charge.

Adduct ( Int  charge,
Int  amount,
DoubleReal  singleMass,
String  formula,
DoubleReal  log_prob,
DoubleReal  rt_shift,
const String  label = "" 
)

C'tor for all members.


Member Function Documentation

String checkFormula_ ( const String formula  )  [private]
const Int& getAmount (  )  const
const Int& getCharge (  )  const
const String& getFormula (  )  const
const String& getLabel (  )  const
const DoubleReal& getLogProb (  )  const
const DoubleReal& getRTShift (  )  const
const DoubleReal& getSingleMass (  )  const
Adduct operator* ( const Int  m  )  const

Increase amount of this adduct by factor.

Parameters:
m 
Adduct operator+ ( const Adduct rhs  ) 

Add two adducts amount if they are equal (defined by equal formula).

void operator+= ( const Adduct rhs  ) 

Add other adducts amount to *this (equal formula required!).

void setAmount ( const Int amount  ) 
void setCharge ( const Int charge  ) 
void setFormula ( const String formula  ) 
void setLogProb ( const DoubleReal log_prob  ) 
void setSingleMass ( const DoubleReal singleMass  ) 

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const Adduct a 
) [friend]

Print the contents of an Adduct to a stream.

bool operator== ( const Adduct a,
const Adduct b 
) [friend]

Comparator.


Member Data Documentation

Int amount_ [private]
Int charge_ [private]
String formula_ [private]
String label_ [private]
DoubleReal log_prob_ [private]
DoubleReal rt_shift_ [private]

OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:51 using doxygen 1.7.1