Description of a file location, used to store the origin of (meta) data. More...
#include <OpenMS/METADATA/SourceFile.h>
Inheritance diagram for SourceFile:
Public Types | |
| enum | ChecksumType { UNKNOWN_CHECKSUM, SHA1, MD5, SIZE_OF_CHECKSUMTYPE } |
| Type of the checksum. More... | |
Public Member Functions | |
| SourceFile () | |
| Constructor. More... | |
| SourceFile (const SourceFile &source) | |
| Copy constructor. More... | |
| ~SourceFile () | |
| Destructor. More... | |
| SourceFile & | operator= (const SourceFile &source) |
| Assignment operator. More... | |
| bool | operator== (const SourceFile &rhs) const |
| Equality operator. More... | |
| bool | operator!= (const SourceFile &rhs) const |
| Equality operator. More... | |
| const String & | getNameOfFile () const |
| returns the file name More... | |
| void | setNameOfFile (const String &name_of_file) |
| sets the file name More... | |
| const String & | getPathToFile () const |
| returns the file path More... | |
| void | setPathToFile (const String &path_path_to_file) |
| sets the file path More... | |
| float | getFileSize () const |
| returns the file size in MB More... | |
| void | setFileSize (float file_size) |
| sets the file size in MB More... | |
| const String & | getFileType () const |
| returns the file type More... | |
| void | setFileType (const String &file_type) |
| sets the file type More... | |
| const String & | getChecksum () const |
| returns the file's checksum More... | |
| void | setChecksum (const String &checksum, ChecksumType type) |
| sets the file's checksum More... | |
| ChecksumType | getChecksumType () const |
| returns the checksum type More... | |
| const String & | getNativeIDType () const |
| Returns the native ID type of the spectra. More... | |
| void | setNativeIDType (const String &type) |
| Sets the native ID type of the spectra. More... | |
 Public Member Functions inherited from CVTermList | |
| CVTermList () | |
| Defaults constructor. More... | |
| CVTermList (const CVTermList &rhs) | |
| Copy constructor. More... | |
| virtual | ~CVTermList () |
| Destructor. More... | |
| CVTermList & | operator= (const CVTermList &rhs) |
| Assignment operator. More... | |
| void | setCVTerms (const std::vector< CVTerm > &terms) |
| sets the CV terms More... | |
| void | replaceCVTerm (const CVTerm &cv_term) |
| replaces the specified CV term More... | |
| void | replaceCVTerms (const std::vector< CVTerm > &cv_terms, const String &accession) |
| replaces the specified CV terms using the given accession number More... | |
| void | replaceCVTerms (const Map< String, std::vector< CVTerm > > &cv_term_map) |
| replaces all cv terms with a map (can be obtained via getCVTerms) More... | |
| void | consumeCVTerms (const Map< String, std::vector< CVTerm > > &cv_term_map) |
| merges the given map into the member map, no duplicate checking More... | |
| const Map< String, std::vector< CVTerm > > & | getCVTerms () const |
| returns the accession string of the term More... | |
| void | addCVTerm (const CVTerm &term) |
| adds a CV term More... | |
| bool | operator== (const CVTermList &cv_term_list) const |
| equality operator More... | |
| bool | operator!= (const CVTermList &cv_term_list) const |
| inequality operator More... | |
| bool | hasCVTerm (const String &accession) const |
| checks whether the term has a value More... | |
| bool | empty () const |
| return true if no terms are available More... | |
| Public Member Functions inherited from MetaInfoInterface | |
| MetaInfoInterface () | |
| constructor More... | |
| MetaInfoInterface (const MetaInfoInterface &rhs) | |
| copy constructor More... | |
| ~MetaInfoInterface () | |
| destructor More... | |
| MetaInfoInterface & | operator= (const MetaInfoInterface &rhs) |
| assignment operator More... | |
| bool | operator== (const MetaInfoInterface &rhs) const |
| Equality operator. More... | |
| bool | operator!= (const MetaInfoInterface &rhs) const |
| Equality operator. More... | |
| const DataValue & | getMetaValue (const String &name) const |
| returns the value corresponding to a string More... | |
| const DataValue & | getMetaValue (UInt index) const |
| returns the value corresponding to an index More... | |
| bool | metaValueExists (const String &name) const |
| returns if this MetaInfo is set More... | |
| bool | metaValueExists (UInt index) const |
| returns if this MetaInfo is set More... | |
| void | setMetaValue (const String &name, const DataValue &value) |
| sets the DataValue corresponding to a name More... | |
| void | setMetaValue (UInt index, const DataValue &value) |
| sets the DataValue corresponding to an index More... | |
| void | removeMetaValue (const String &name) |
Removes the DataValue corresponding to name if it exists. More... | |
| void | removeMetaValue (UInt index) |
Removes the DataValue corresponding to index if it exists. More... | |
| void | getKeys (std::vector< String > &keys) const |
| fills the given vector with a list of all keys for which a value is set More... | |
| void | getKeys (std::vector< UInt > &keys) const |
| fills the given vector with a list of all keys for which a value is set More... | |
| bool | isMetaEmpty () const |
| returns if the MetaInfo is empty More... | |
| void | clearMetaInfo () |
| removes all meta values More... | |
Static Public Attributes | |
| static const std::string | NamesOfChecksumType [SIZE_OF_CHECKSUMTYPE] |
| Names of checksum types. More... | |
Protected Attributes | |
| String | name_of_file_ |
| String | path_to_file_ |
| double | file_size_ |
| String | file_type_ |
| String | checksum_ |
| ChecksumType | checksum_type_ |
| String | native_id_type_ |
| Protected Attributes inherited from CVTermList | |
| Map< String, std::vector< CVTerm > > | cv_terms_ |
| Protected Attributes inherited from MetaInfoInterface | |
| MetaInfo * | meta_ |
| pointer to the MetaInfo object. 0 by default More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from MetaInfoInterface | |
| static MetaInfoRegistry & | metaRegistry () |
| returns a reference to the MetaInfoRegistry More... | |
| Protected Member Functions inherited from MetaInfoInterface | |
| void | createIfNotExists_ () |
| creates the MetaInfo object if it does not exist More... | |
Detailed Description
Description of a file location, used to store the origin of (meta) data.
Constructor & Destructor Documentation
| SourceFile | ( | ) |
Constructor.
| SourceFile | ( | const SourceFile & | source | ) |
Copy constructor.
| ~SourceFile | ( | ) |
Destructor.
Member Function Documentation
| const String& getChecksum | ( | ) | const |
returns the file's checksum
Referenced by MzMLHandler< MapType >::writeSourceFile_(), and MzXMLHandler< MapType >::writeTo().
| ChecksumType getChecksumType | ( | ) | const |
returns the checksum type
Referenced by MzMLHandler< MapType >::writeSourceFile_(), and MzXMLHandler< MapType >::writeTo().
| float getFileSize | ( | ) | const |
returns the file size in MB
| const String& getFileType | ( | ) | const |
returns the file type
Referenced by MzMLHandler< MapType >::writeSourceFile_(), and MzXMLHandler< MapType >::writeTo().
| const String& getNameOfFile | ( | ) | const |
returns the file name
Referenced by MzMLHandler< MapType >::writeSourceFile_(), and MzXMLHandler< MapType >::writeTo().
| const String& getNativeIDType | ( | ) | const |
Returns the native ID type of the spectra.
Referenced by MzMLHandler< MapType >::writeSourceFile_().
| const String& getPathToFile | ( | ) | const |
returns the file path
Referenced by MzMLHandler< MapType >::writeSourceFile_().
| bool operator!= | ( | const SourceFile & | rhs | ) | const |
Equality operator.
| SourceFile& operator= | ( | const SourceFile & | source | ) |
Assignment operator.
| bool operator== | ( | const SourceFile & | rhs | ) | const |
Equality operator.
| void setChecksum | ( | const String & | checksum, |
| ChecksumType | type | ||
| ) |
sets the file's checksum
Referenced by FileHandler::loadExperiment(), and MzXMLHandler< MapType >::startElement().
| void setFileSize | ( | float | file_size | ) |
sets the file size in MB
Referenced by XMassFile::load().
| void setFileType | ( | const String & | file_type | ) |
sets the file type
Referenced by XMassFile::load(), FileHandler::loadExperiment(), and MzXMLHandler< MapType >::startElement().
| void setNameOfFile | ( | const String & | name_of_file | ) |
sets the file name
Referenced by XMassFile::load(), FileHandler::loadExperiment(), and MzXMLHandler< MapType >::startElement().
| void setNativeIDType | ( | const String & | type | ) |
Sets the native ID type of the spectra.
| void setPathToFile | ( | const String & | path_path_to_file | ) |
sets the file path
Referenced by XMassFile::load(), and FileHandler::loadExperiment().
Member Data Documentation
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
static |
Names of checksum types.
|
protected |
|
protected |