OpenMS
SourceFile Class Reference

Description of a file location, used to store the origin of (meta) data. More...

#include <OpenMS/METADATA/SourceFile.h>

Inheritance diagram for SourceFile:
[legend]
Collaboration diagram for SourceFile:
[legend]

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 &)=default
 Copy constructor. More...
 
 SourceFile (SourceFile &&)=default
 Move constructor. More...
 
 ~SourceFile () override
 Destructor. More...
 
SourceFileoperator= (const SourceFile &)=default
 Assignment operator. More...
 
SourceFileoperator= (SourceFile &&)=default
 Move assignment operator. More...
 
bool operator== (const SourceFile &rhs) const
 Equality operator. More...
 
bool operator!= (const SourceFile &rhs) const
 Equality operator. More...
 
const StringgetNameOfFile () const
 returns the file name More...
 
void setNameOfFile (const String &name_of_file)
 sets the file name More...
 
const StringgetPathToFile () 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 StringgetFileType () const
 returns the file type More...
 
void setFileType (const String &file_type)
 sets the file type More...
 
const StringgetChecksum () 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 StringgetNativeIDType () const
 Returns the native ID type of the spectra. More...
 
void setNativeIDType (const String &type)
 Sets the native ID type of the spectra. More...
 
const StringgetNativeIDTypeAccession () const
 Returns the nativeID of the spectra. More...
 
void setNativeIDTypeAccession (const String &accesssion)
 Sets the native ID of the spectra. More...
 
- Public Member Functions inherited from CVTermList
 CVTermList ()=default
 Defaults constructor. More...
 
 CVTermList (const CVTermList &)=default
 Copy constructor. More...
 
 CVTermList (CVTermList &&) noexcept
 Move constructor. More...
 
virtual ~CVTermList ()
 Destructor. More...
 
CVTermListoperator= (const CVTermList &rhs) &=default
 Assignment operator. More...
 
CVTermListoperator= (CVTermList &&) &=default
 Move 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 std::map< String, std::vector< CVTerm > > &cv_term_map)
 replaces all cv terms with a map (can be obtained via getCVTerms) More...
 
void consumeCVTerms (const std::map< String, std::vector< CVTerm > > &cv_term_map)
 merges the given map into the member map, no duplicate checking More...
 
const std::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 (MetaInfoInterface &&) noexcept
 Move constructor. More...
 
 ~MetaInfoInterface ()
 Destructor. More...
 
MetaInfoInterfaceoperator= (const MetaInfoInterface &rhs)
 Assignment operator. More...
 
MetaInfoInterfaceoperator= (MetaInfoInterface &&) noexcept
 Move assignment operator. More...
 
void swap (MetaInfoInterface &rhs)
 Swap contents. More...
 
bool operator== (const MetaInfoInterface &rhs) const
 Equality operator. More...
 
bool operator!= (const MetaInfoInterface &rhs) const
 Equality operator. More...
 
const DataValuegetMetaValue (const String &name) const
 Returns the value corresponding to a string, or DataValue::EMPTY if not found. More...
 
DataValue getMetaValue (const String &name, const DataValue &default_value) const
 Returns the value corresponding to a string, or a default value (e.g.: DataValue::EMPTY) if not found
More...
 
const DataValuegetMetaValue (UInt index) const
 Returns the value corresponding to the index, or DataValue::EMPTY if not found. More...
 
DataValue getMetaValue (UInt index, const DataValue &default_value) const
 Returns the value corresponding to the index, or a default value (e.g.: DataValue::EMPTY) if not found
More...
 
bool metaValueExists (const String &name) const
 Returns whether an entry with the given name exists. More...
 
bool metaValueExists (UInt index) const
 Returns whether an entry with the given index exists. 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 addMetaValues (const MetaInfoInterface &from)
 function to copy all meta values from one object to this one 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_ = SourceFile::ChecksumType::UNKNOWN_CHECKSUM
 
String native_id_type_
 
String native_id_type_accession_
 
- Protected Attributes inherited from CVTermList
std::map< String, std::vector< CVTerm > > cv_terms_
 
- Protected Attributes inherited from MetaInfoInterface
MetaInfometa_
 Pointer to the MetaInfo object (0 by default) More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MetaInfoInterface
static MetaInfoRegistrymetaRegistry ()
 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.

Member Enumeration Documentation

◆ ChecksumType

Type of the checksum.

Enumerator
UNKNOWN_CHECKSUM 

Unknown checksum type.

SHA1 

Secure Hash Algorithm-1.

MD5 

Message-Digest algorithm 5.

SIZE_OF_CHECKSUMTYPE 

Constructor & Destructor Documentation

◆ SourceFile() [1/3]

Constructor.

◆ SourceFile() [2/3]

SourceFile ( const SourceFile )
default

Copy constructor.

◆ SourceFile() [3/3]

SourceFile ( SourceFile &&  )
default

Move constructor.

◆ ~SourceFile()

~SourceFile ( )
override

Destructor.

Member Function Documentation

◆ getChecksum()

const String& getChecksum ( ) const

returns the file's checksum

◆ getChecksumType()

ChecksumType getChecksumType ( ) const

returns the checksum type

◆ getFileSize()

float getFileSize ( ) const

returns the file size in MB

◆ getFileType()

const String& getFileType ( ) const

returns the file type

◆ getNameOfFile()

const String& getNameOfFile ( ) const

returns the file name

◆ getNativeIDType()

const String& getNativeIDType ( ) const

Returns the native ID type of the spectra.

◆ getNativeIDTypeAccession()

const String& getNativeIDTypeAccession ( ) const

Returns the nativeID of the spectra.

◆ getPathToFile()

const String& getPathToFile ( ) const

returns the file path

◆ operator!=()

bool operator!= ( const SourceFile rhs) const

Equality operator.

◆ operator=() [1/2]

SourceFile& operator= ( const SourceFile )
default

Assignment operator.

◆ operator=() [2/2]

SourceFile& operator= ( SourceFile &&  )
default

Move assignment operator.

◆ operator==()

bool operator== ( const SourceFile rhs) const

Equality operator.

◆ setChecksum()

void setChecksum ( const String checksum,
ChecksumType  type 
)

sets the file's checksum

◆ setFileSize()

void setFileSize ( float  file_size)

sets the file size in MB

Referenced by XMassFile::load().

◆ setFileType()

void setFileType ( const String file_type)

sets the file type

Referenced by XMassFile::load().

◆ setNameOfFile()

void setNameOfFile ( const String name_of_file)

sets the file name

Referenced by XMassFile::load().

◆ setNativeIDType()

void setNativeIDType ( const String type)

Sets the native ID type of the spectra.

◆ setNativeIDTypeAccession()

void setNativeIDTypeAccession ( const String accesssion)

Sets the native ID of the spectra.

◆ setPathToFile()

void setPathToFile ( const String path_path_to_file)

sets the file path

Referenced by XMassFile::load().

Member Data Documentation

◆ checksum_

String checksum_
protected

◆ checksum_type_

ChecksumType checksum_type_ = SourceFile::ChecksumType::UNKNOWN_CHECKSUM
protected

◆ file_size_

double file_size_
protected

◆ file_type_

String file_type_
protected

◆ name_of_file_

String name_of_file_
protected

◆ NamesOfChecksumType

const std::string NamesOfChecksumType[SIZE_OF_CHECKSUMTYPE]
static

Names of checksum types.

◆ native_id_type_

String native_id_type_
protected

◆ native_id_type_accession_

String native_id_type_accession_
protected

◆ path_to_file_

String path_to_file_
protected