OpenMS
Loading...
Searching...
No Matches
MzIdentMLFile.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: Mathias Walzer $
6// $Authors: Andreas Bertsch, Mathias Walzer $
7// --------------------------------------------------------------------------
8
9#pragma once
10
17
18#include <vector>
19
20namespace OpenMS
21{
41 class OPENMS_DLLAPI MzIdentMLFile :
42 public Internal::XMLFile,
43 public ProgressLogger
44 {
45public:
49 ~MzIdentMLFile() override;
50
57 void load(const std::string& filename, std::vector<ProteinIdentification>& poid, PeptideIdentificationList& peid);
58
64 void store(const std::string& filename, const std::vector<ProteinIdentification>& poid, const PeptideIdentificationList& peid) const;
65
75 bool isSemanticallyValid(const std::string& filename, StringList& errors, StringList& warnings);
76
92 bool isValid(const std::string& filename, std::ostream& os, std::string& used_version);
93
100 std::string detectVersion(const std::string& filename) const;
101
102private:
103
104 };
105
106} // namespace OpenMS
107
Base class for loading and storing XML files via Xerces, with optional schema validation and transpar...
Definition XMLFile.h:38
File adapter for MzIdentML files.
Definition MzIdentMLFile.h:44
std::string detectVersion(const std::string &filename) const
Detect the mzIdentML version declared in filename (e.g. "1.1.0").
MzIdentMLFile()
Default constructor.
~MzIdentMLFile() override
Destructor.
bool isValid(const std::string &filename, std::ostream &os, std::string &used_version)
Checks if a file validates against the mzIdentML schema that matches its declared version.
bool isSemanticallyValid(const std::string &filename, StringList &errors, StringList &warnings)
Checks if a file is valid with respect to the mapping file and the controlled vocabulary.
void load(const std::string &filename, std::vector< ProteinIdentification > &poid, PeptideIdentificationList &peid)
Loads the identifications from a MzIdentML file.
void store(const std::string &filename, const std::vector< ProteinIdentification > &poid, const PeptideIdentificationList &peid) const
Stores the identifications in a MzIdentML file.
Container for peptide identifications from multiple spectra.
Definition PeptideIdentificationList.h:66
Base class for all classes that want to report their progress.
Definition ProgressLogger.h:27
std::vector< std::string > StringList
Vector of String.
Definition ListUtils.h:44
Main OpenMS namespace.
Definition openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19