Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

ExperimentalSettings Class Reference
[Metadata]

#include <OpenMS/METADATA/ExperimentalSettings.h>

Inheritance diagram for ExperimentalSettings:

MetaInfoInterface FeatureMap MSExperiment

List of all members.


Detailed Description

Description of the experimental settings.

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

Public Types

enum  ExperimentType {
  UNKNOWN, MS, MS_MS, HPLC_MS,
  HPLC_MS_MS, SIZE_OF_EXPERIMENTTYPE
}
 Type of the experiment. More...

Public Member Functions

 ExperimentalSettings ()
 Constructor.
 ExperimentalSettings (const ExperimentalSettings &source)
 Copy constructor.
 ~ExperimentalSettings ()
 Destructor.
ExperimentalSettingsoperator= (const ExperimentalSettings &source)
 Assignment operator.
bool operator== (const ExperimentalSettings &rhs) const
 Equality operator.
bool operator!= (const ExperimentalSettings &rhs) const
 Equality operator.
const SamplegetSample () const
 returns a const reference to the sample description
SamplegetSample ()
 returns a mutable reference to the sample description
void setSample (const Sample &sample)
 sets the sample description
const SourceFilegetSourceFile () const
 returns a const reference to the source date file
SourceFilegetSourceFile ()
 returns a mutable reference to the source date file
void setSourceFile (const SourceFile &source_file)
 sets the source date 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 InstrumentgetInstrument () const
 returns a const reference to the MS instrument description
InstrumentgetInstrument ()
 returns a mutable reference to the MS instrument description
void setInstrument (const Instrument &instrument)
 sets the MS instrument description
const SoftwaregetSoftware () const
 returns a const reference to the software used for processing
SoftwaregetSoftware ()
 returns a mutable reference to the software used for processing
void setSoftware (const Software &software)
 sets the software used for processing
const ProcessingMethodgetProcessingMethod () const
 returns a const reference to the description of the applied processing
ProcessingMethodgetProcessingMethod ()
 returns a mutable reference to the description of the applied processing
void setProcessingMethod (const ProcessingMethod &processing_method)
 sets the description of the applied processing
const HPLCgetHPLC () const
 returns a const reference to the description of the HPLC run
HPLCgetHPLC ()
 returns a mutable reference to the description of the HPLC run
void setHPLC (const HPLC &hplc)
 sets the description of the HPLC run
ExperimentType getType () const
 returns the experiment type
void setType (ExperimentType type)
 sets the experiment type
const DategetDate () const
 returns the date the experiment was performed
void setDate (const Date &date)
 sets the date the experiment was performed
const StringgetComment () 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
void addProteinIdentification (ProteinIdentification &protein_identification)
 adds an ProteinIdentification to the ProteinIdentification vector

Static Public Attributes

static const std::string NamesOfExperimentType [SIZE_OF_EXPERIMENTTYPE]
 Names of experiment types.

Protected Attributes

Sample sample_
SourceFile source_file_
std::vector< ContactPersoncontacts_
Instrument instrument_
Software software_
ProcessingMethod processing_method_
HPLC hplc_
ExperimentType type_
Date date_
String comment_
std::vector
< ProteinIdentification
protein_identifications_


Member Enumeration Documentation

enum ExperimentType

Type of the experiment.

Enumerator:
UNKNOWN  Unknown experiment type.
MS  MS experiment.
MS_MS  Tandem MS experiment.
HPLC_MS  HPLC-MS experiment.
HPLC_MS_MS  HPLC-MS experiment with tandem MS information.
SIZE_OF_EXPERIMENTTYPE  Number of experiment types (can be used to iterate over the names).


Constructor & Destructor Documentation

ExperimentalSettings (  ) 

Constructor.

ExperimentalSettings ( const ExperimentalSettings source  ) 

Copy constructor.

~ExperimentalSettings (  ) 

Destructor.


Member Function Documentation

ExperimentalSettings& operator= ( const ExperimentalSettings source  ) 

Assignment operator.

Reimplemented in MSExperiment, and MSExperiment< OpenMS::PickedPeak1D >.

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 SourceFile& getSourceFile (  )  const

returns a const reference to the source date file

SourceFile& getSourceFile (  ) 

returns a mutable reference to the source date file

void setSourceFile ( const SourceFile source_file  ) 

sets the source date 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 Software& getSoftware (  )  const

returns a const reference to the software used for processing

Software& getSoftware (  ) 

returns a mutable reference to the software used for processing

void setSoftware ( const Software software  ) 

sets the software used for processing

const ProcessingMethod& getProcessingMethod (  )  const

returns a const reference to the description of the applied processing

ProcessingMethod& getProcessingMethod (  ) 

returns a mutable reference to the description of the applied processing

void setProcessingMethod ( const ProcessingMethod processing_method  ) 

sets the description of the applied processing

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

ExperimentType getType (  )  const

returns the experiment type

void setType ( ExperimentType  type  ) 

sets the experiment type

const Date& getDate (  )  const

returns the date the experiment was performed

void setDate ( const Date 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

void addProteinIdentification ( ProteinIdentification protein_identification  ) 

adds an ProteinIdentification to the ProteinIdentification vector


Member Data Documentation

const std::string NamesOfExperimentType[SIZE_OF_EXPERIMENTTYPE] [static]

Names of experiment types.

Sample sample_ [protected]

SourceFile source_file_ [protected]

std::vector<ContactPerson> contacts_ [protected]

Instrument instrument_ [protected]

Software software_ [protected]

ProcessingMethod processing_method_ [protected]

HPLC hplc_ [protected]

ExperimentType type_ [protected]

Date date_ [protected]

String comment_ [protected]

std::vector<ProteinIdentification> protein_identifications_ [protected]


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:46 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1