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

MetaInfoDescription Class Reference
[Metadata]

#include <OpenMS/METADATA/MetaInfoDescription.h>

Inheritance diagram for MetaInfoDescription:

MetaInfoInterface

List of all members.


Detailed Description

Description of the meta info added to each peak.

The described meta info is stored using the MetaInfoInterface of DPeak.

Public Member Functions

 MetaInfoDescription ()
 Constructor.
 MetaInfoDescription (const MetaInfoDescription &source)
 Copy constructor.
 ~MetaInfoDescription ()
 Destructor.
MetaInfoDescriptionoperator= (const MetaInfoDescription &source)
 Assignment operator.
bool operator== (const MetaInfoDescription &rhs) const
 Equality operator.
const StringgetComment () const
 returns the free-text comment
void setComment (const String &comment)
 sets the free-text comment
const SourceFilegetSourceFile () const
 returns a const reference to the source file the information
SourceFilegetSourceFile ()
 returns a mutable reference to the source file the information
void setSourceFile (const SourceFile &source_file)
 sets the source file the information
const StringgetName () const
 returns the name of the peak annotations
void setName (const String &name)
 sets the name of the peak annotations

Protected Attributes

String comment_
String name_
SourceFile source_file_


Constructor & Destructor Documentation

MetaInfoDescription (  ) 

Constructor.

MetaInfoDescription ( const MetaInfoDescription source  ) 

Copy constructor.

~MetaInfoDescription (  ) 

Destructor.


Member Function Documentation

MetaInfoDescription& operator= ( const MetaInfoDescription source  ) 

Assignment operator.

bool operator== ( const MetaInfoDescription rhs  )  const

Equality operator.

const String& getComment (  )  const

returns the free-text comment

void setComment ( const String comment  ) 

sets the free-text comment

const SourceFile& getSourceFile (  )  const

returns a const reference to the source file the information

SourceFile& getSourceFile (  ) 

returns a mutable reference to the source file the information

void setSourceFile ( const SourceFile source_file  ) 

sets the source file the information

const String& getName (  )  const

returns the name of the peak annotations

void setName ( const String name  ) 

sets the name of the peak annotations


Member Data Documentation

String comment_ [protected]

String name_ [protected]

SourceFile source_file_ [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