| OpenMS 2.5.0

SourceFile.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-2020.
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: Timo Sachsenberg $
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/METADATA/CVTermList.h>
38
39 namespace OpenMS
40 {
46 class OPENMS_DLLAPI SourceFile :
47 public CVTermList
48 {
49 public:
51 enum ChecksumType
52 {
53 UNKNOWN_CHECKSUM,
54 SHA1,
55 MD5,
56 SIZE_OF_CHECKSUMTYPE
57 };
58
60 static const std::string NamesOfChecksumType[SIZE_OF_CHECKSUMTYPE];
61
63 SourceFile();
65 SourceFile(const SourceFile&) = default;
67 SourceFile(SourceFile&&) = default;
69 ~SourceFile() override;
70
72 SourceFile& operator=(const SourceFile&) = default;
74 SourceFile& operator=(SourceFile&&) & = default;
75
77 bool operator==(const SourceFile& rhs) const;
79 bool operator!=(const SourceFile& rhs) const;
80
82 const String& getNameOfFile() const;
84 void setNameOfFile(const String& name_of_file);
85
87 const String& getPathToFile() const;
89 void setPathToFile(const String& path_path_to_file);
90
92 float getFileSize() const;
94 void setFileSize(float file_size);
95
97 const String& getFileType() const;
99 void setFileType(const String& file_type);
100
102 const String& getChecksum() const;
104 void setChecksum(const String& checksum, ChecksumType type);
106 ChecksumType getChecksumType() const;
107
109 const String& getNativeIDType() const;
111 void setNativeIDType(const String& type);
112
114 const String& getNativeIDTypeAccession() const;
116 void setNativeIDTypeAccession(const String& accesssion);
117
118 protected:
119 String name_of_file_;
120 String path_to_file_;
121 double file_size_;
122 String file_type_;
123 String checksum_;
124 ChecksumType checksum_type_ = SourceFile::ChecksumType::UNKNOWN_CHECKSUM;
125 String native_id_type_;
126 String native_id_type_accession_;
127 };
128 } // namespace OpenMS
129
OpenMS::SourceFile::SHA1
Secure Hash Algorithm-1.
Definition: SourceFile.h:54
OpenMS::CVTermList
Representation of controlled vocabulary term list.
Definition: CVTermList.h:52
OpenMS::SourceFile
Description of a file location, used to store the origin of (meta) data.
Definition: SourceFile.h:46
OpenMS::SourceFile::ChecksumType
ChecksumType
Type of the checksum.
Definition: SourceFile.h:51
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::SourceFile::checksum_
String checksum_
Definition: SourceFile.h:123
KDTree::operator!=
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
OpenMS::SourceFile::name_of_file_
String name_of_file_
Definition: SourceFile.h:119
OpenMS::SourceFile::native_id_type_
String native_id_type_
Definition: SourceFile.h:125
OpenMS::SourceFile::file_size_
double file_size_
Definition: SourceFile.h:121
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::SourceFile::native_id_type_accession_
String native_id_type_accession_
Definition: SourceFile.h:126
OpenMS::SourceFile::MD5
Message-Digest algorithm 5.
Definition: SourceFile.h:55
OpenMS::SourceFile::UNKNOWN_CHECKSUM
Unknown checksum type.
Definition: SourceFile.h:53
CVTermList.h
OpenMS::SourceFile::file_type_
String file_type_
Definition: SourceFile.h:122
OpenMS::SourceFile::path_to_file_
String path_to_file_
Definition: SourceFile.h:120
KDTree::operator==
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806