OpenMS
3.3.0
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
MetaInfoDescription.h
Go to the documentation of this file.
1
// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
2
// SPDX-License-Identifier: BSD-3-Clause
3
//
4
// --------------------------------------------------------------------------
5
// $Maintainer: Timo Sachsenberg $
6
// $Authors: Marc Sturm $
7
// --------------------------------------------------------------------------
8
9
#pragma once
10
11
#include <
OpenMS/DATASTRUCTURES/String.h
>
12
#include <
OpenMS/METADATA/DataProcessing.h
>
13
#include <
OpenMS/METADATA/MetaInfoInterface.h
>
14
15
namespace
OpenMS
16
{
22
class
OPENMS_DLLAPI
MetaInfoDescription
:
23
public
MetaInfoInterface
24
{
25
public
:
27
MetaInfoDescription
() =
default
;
29
MetaInfoDescription
(
const
MetaInfoDescription
&) =
default
;
31
MetaInfoDescription
(
MetaInfoDescription
&&) =
default
;
33
~MetaInfoDescription
();
34
36
MetaInfoDescription
&
operator=
(
const
MetaInfoDescription
&) =
default
;
38
MetaInfoDescription
&
operator=
(
MetaInfoDescription
&&) & =
default
;
39
41
bool
operator==
(
const
MetaInfoDescription
& rhs)
const
;
42
44
const
String
&
getName
()
const
;
46
void
setName
(
const
String
& name);
47
49
const
std::vector<ConstDataProcessingPtr> &
getDataProcessing
()
const
;
51
std::vector<DataProcessingPtr> &
getDataProcessing
();
53
void
setDataProcessing
(
const
std::vector<DataProcessingPtr> & data_processing);
54
55
protected
:
56
String
comment_
;
57
String
name_
;
58
std::vector<DataProcessingPtr>
data_processing_
;
59
};
60
}
// namespace OpenMS
61
DataProcessing.h
MetaInfoInterface.h
String.h
OpenMS::MetaInfoDescription
Description of the meta data arrays of MSSpectrum.
Definition:
MetaInfoDescription.h:24
OpenMS::MetaInfoDescription::comment_
String comment_
Definition:
MetaInfoDescription.h:56
OpenMS::MetaInfoDescription::operator=
MetaInfoDescription & operator=(const MetaInfoDescription &)=default
Assignment operator.
OpenMS::MetaInfoDescription::operator=
MetaInfoDescription & operator=(MetaInfoDescription &&) &=default
Move assignment operator.
OpenMS::MetaInfoDescription::name_
String name_
Definition:
MetaInfoDescription.h:57
OpenMS::MetaInfoDescription::operator==
bool operator==(const MetaInfoDescription &rhs) const
Equality operator.
OpenMS::MetaInfoDescription::~MetaInfoDescription
~MetaInfoDescription()
Destructor.
OpenMS::MetaInfoDescription::setName
void setName(const String &name)
sets the name of the peak annotations
OpenMS::MetaInfoDescription::getDataProcessing
const std::vector< ConstDataProcessingPtr > & getDataProcessing() const
returns a const reference to the description of the applied processing
OpenMS::MetaInfoDescription::MetaInfoDescription
MetaInfoDescription(MetaInfoDescription &&)=default
Move constructor.
OpenMS::MetaInfoDescription::setDataProcessing
void setDataProcessing(const std::vector< DataProcessingPtr > &data_processing)
sets the description of the applied processing
OpenMS::MetaInfoDescription::getName
const String & getName() const
returns the name of the peak annotations
OpenMS::MetaInfoDescription::MetaInfoDescription
MetaInfoDescription()=default
Constructor.
OpenMS::MetaInfoDescription::data_processing_
std::vector< DataProcessingPtr > data_processing_
Definition:
MetaInfoDescription.h:58
OpenMS::MetaInfoDescription::getDataProcessing
std::vector< DataProcessingPtr > & getDataProcessing()
returns a mutable reference to the description of the applied processing
OpenMS::MetaInfoDescription::MetaInfoDescription
MetaInfoDescription(const MetaInfoDescription &)=default
Copy constructor.
OpenMS::MetaInfoInterface
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition:
MetaInfoInterface.h:35
OpenMS::String
A more convenient string class.
Definition:
String.h:34
OpenMS
Main OpenMS namespace.
Definition:
openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19
OpenMS
METADATA
MetaInfoDescription.h
Generated on Sat Dec 21 2024 15:56:41 for OpenMS by
1.9.1