Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | Protected Attributes

ExperimentalSettings Class Reference
[Metadata]

Description of the experimental settings. More...

#include <OpenMS/METADATA/ExperimentalSettings.h>

Inheritance diagram for ExperimentalSettings:
MetaInfoInterface DocumentIdentifier MSExperiment< PeakT, ChromatogramPeakT > MSQuantifications

List of all members.

Public Member Functions

 ExperimentalSettings ()
 Constructor.
 ExperimentalSettings (const ExperimentalSettings &source)
 Copy constructor.
 ~ExperimentalSettings ()
 Destructor.
ExperimentalSettings & operator= (const ExperimentalSettings &source)
 Assignment operator.
bool operator== (const ExperimentalSettings &rhs) const
 Equality operator.
bool operator!= (const ExperimentalSettings &rhs) const
 Equality operator.
const Sample & getSample () const
 returns a const reference to the sample description
Sample & getSample ()
 returns a mutable reference to the sample description
void setSample (const Sample &sample)
 sets the sample description
const std::vector< SourceFile > & getSourceFiles () const
 returns a const reference to the source data file
std::vector< SourceFile > & getSourceFiles ()
 returns a mutable reference to the source data file
void setSourceFiles (const std::vector< SourceFile > &source_files)
 sets the source data file
const std::vector
< ContactPerson > & 		getContacts () const
 returns a const reference to the list of contact persons
std::vector< ContactPerson > & getContacts ()
 returns a mutable reference to the list of contact persons
void setContacts (const std::vector< ContactPerson > &contacts)
 sets the list of contact persons
const Instrument & getInstrument () const
 returns a const reference to the MS instrument description
Instrument & getInstrument ()
 returns a mutable reference to the MS instrument description
void setInstrument (const Instrument &instrument)
 sets the MS instrument description
const HPLC & getHPLC () const
 returns a const reference to the description of the HPLC run
HPLC & getHPLC ()
 returns a mutable reference to the description of the HPLC run
void setHPLC (const HPLC &hplc)
 sets the description of the HPLC run
const DateTime & getDateTime () const
 returns the date the experiment was performed
void setDateTime (const DateTime &date)
 sets the date the experiment was performed
const String & getComment () const
 returns the free-text comment
void setComment (const String &comment)
 sets the free-text comment
const std::vector
< ProteinIdentification > & 		getProteinIdentifications () const
 returns a const reference to the protein ProteinIdentification vector
std::vector
< ProteinIdentification > & 		getProteinIdentifications ()
 returns a mutable reference to the protein ProteinIdentification vector
void setProteinIdentifications (const std::vector< ProteinIdentification > &protein_identifications)
 sets the protein ProteinIdentification vector
const String & getFractionIdentifier () const
 returns fraction identifier
void setFractionIdentifier (const String &fraction_identifier)
 sets the fraction identifier

Protected Attributes

Sample sample_
std::vector< SourceFile > source_files_
std::vector< ContactPerson > contacts_
Instrument instrument_
HPLC hplc_
DateTime datetime_
String comment_
std::vector
< ProteinIdentification > 		protein_identifications_
String fraction_identifier_

Detailed Description

Description of the experimental settings.

These settings are valid for the whole experiment. See SpectrumSettings for settings which are spectrum specific.

Constructor & Destructor Documentation

ExperimentalSettings (  ) 

Constructor.

Referenced by MSExperiment< SimPointType >::clear(), and MSExperiment< SimPointType >::reset().

ExperimentalSettings ( const ExperimentalSettings &  source  ) 

Copy constructor.

~ExperimentalSettings (  ) 

Destructor.

Member Function Documentation

const String& getComment (  )  const

returns the free-text comment

const std::vector<ContactPerson>& getContacts (  )  const

returns a const reference to the list of contact persons

std::vector<ContactPerson>& getContacts (  ) 

returns a mutable reference to the list of contact persons

const DateTime& getDateTime (  )  const

returns the date the experiment was performed

const String& getFractionIdentifier (  )  const

returns fraction identifier

HPLC& getHPLC (  ) 

returns a mutable reference to the description of the HPLC run

const HPLC& getHPLC (  )  const

returns a const reference to the description of the HPLC run

const Instrument& getInstrument (  )  const

returns a const reference to the MS instrument description

Referenced by XMassFile::importExperimentalSettings().

Instrument& getInstrument (  ) 

returns a mutable reference to the MS instrument description

const std::vector<ProteinIdentification>& getProteinIdentifications (  )  const

returns a const reference to the protein ProteinIdentification vector

Referenced by IDMapper::annotate(), IDFilter::filterIdentificationsByBestNHits(), IDFilter::filterIdentificationsByScores(), and IDFilter::filterIdentificationsByThresholds().

std::vector<ProteinIdentification>& getProteinIdentifications (  ) 

returns a mutable reference to the protein ProteinIdentification vector

const Sample& getSample (  )  const

returns a const reference to the sample description

Sample& getSample (  ) 

returns a mutable reference to the sample description

std::vector<SourceFile>& getSourceFiles (  ) 

returns a mutable reference to the source data file

const std::vector<SourceFile>& getSourceFiles (  )  const

returns a const reference to the source data file

bool operator!= ( const ExperimentalSettings &  rhs  )  const

Equality operator.

ExperimentalSettings& operator= ( const ExperimentalSettings &  source  ) 

Assignment operator.

bool operator== ( const ExperimentalSettings &  rhs  )  const

Equality operator.

void setComment ( const String &  comment  ) 

sets the free-text comment

void setContacts ( const std::vector< ContactPerson > &  contacts  ) 

sets the list of contact persons

void setDateTime ( const DateTime &  date  ) 

sets the date the experiment was performed

void setFractionIdentifier ( const String &  fraction_identifier  ) 

sets the fraction identifier

void setHPLC ( const HPLC &  hplc  ) 

sets the description of the HPLC run

void setInstrument ( const Instrument &  instrument  ) 

sets the MS instrument description

void setProteinIdentifications ( const std::vector< ProteinIdentification > &  protein_identifications  ) 

sets the protein ProteinIdentification vector

Referenced by IDFilter::filterIdentificationsByBestNHits(), IDFilter::filterIdentificationsByScores(), and IDFilter::filterIdentificationsByThresholds().

void setSample ( const Sample &  sample  ) 

sets the sample description

void setSourceFiles ( const std::vector< SourceFile > &  source_files  ) 

sets the source data file

Member Data Documentation

String comment_ [protected]
std::vector<ContactPerson> contacts_ [protected]
DateTime datetime_ [protected]
String fraction_identifier_ [protected]
HPLC hplc_ [protected]
Instrument instrument_ [protected]
std::vector<ProteinIdentification> protein_identifications_ [protected]
Sample sample_ [protected]
std::vector<SourceFile> source_files_ [protected]
OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:56 using doxygen 1.7.1