OpenMS
DocumentIdentifier.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2023.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Chris Bielow $
32 // $Authors: $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 // OpenMS
40 
41 namespace OpenMS
42 {
55  class OPENMS_DLLAPI DocumentIdentifier
56  {
57 public:
61 
64 
67 
70 
73 
76 
79 
81  bool operator==(const DocumentIdentifier & rhs) const;
82 
84 
88 
90  void setIdentifier(const String & id);
91 
93  const String & getIdentifier() const;
94 
96  void swap(DocumentIdentifier & from);
97 
98 
100  void setLoadedFilePath(const String & file_name);
101 
103  const String & getLoadedFilePath() const;
104 
106  void setLoadedFileType(const String & file_name);
107 
110 
112 
113 protected:
120  };
121 } // namespace OpenMS
122 
Manage source document information.
Definition: DocumentIdentifier.h:56
void setIdentifier(const String &id)
set document identifier (e.g. an LSID)
const String & getIdentifier() const
retrieve document identifier (e.g. an LSID)
const String & getLoadedFilePath() const
get the file_name_ which is the absolute path to the file loaded from
DocumentIdentifier & operator=(const DocumentIdentifier &)=default
Assignment operator.
DocumentIdentifier(const DocumentIdentifier &)=default
Copy constructor.
virtual ~DocumentIdentifier()
Destructor.
void setLoadedFilePath(const String &file_name)
set the file_name_ according to absolute path of the file loaded from preferably done whilst loading
DocumentIdentifier(DocumentIdentifier &&)=default
Move constructor.
DocumentIdentifier & operator=(DocumentIdentifier &&) &=default
Move assignment operator.
DocumentIdentifier()
Default constructor.
const FileTypes::Type & getLoadedFileType() const
get the file_type (e.g. featureXML, consensusXML, mzData, mzXML, mzML, ...) of the file loaded from
bool operator==(const DocumentIdentifier &rhs) const
Equality operator.
String file_path_
the path to the loaded file
Definition: DocumentIdentifier.h:117
String id_
the ID (e.g. LSID)
Definition: DocumentIdentifier.h:115
FileTypes::Type file_type_
the type of the loaded file
Definition: DocumentIdentifier.h:119
void setLoadedFileType(const String &file_name)
set the file_type according to the type of the file loaded from (see FileHandler::Type) preferably do...
void swap(DocumentIdentifier &from)
exchange content with from
A more convenient string class.
Definition: String.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48
Type
Actual file types enum.
Definition: FileTypes.h:57