| OpenMS 2.5.0

Public Member Functions | Protected Attributes | List of all members
Software Class Reference
Metadata

Description of the software used for processing. More...

`#include <OpenMS/METADATA/Software.h>`

Inheritance diagram for Software:

## Public Member Functions

| Software (const String &name="", const String &version="")
| Constructor. More...
| Software (const Software &)=default
| Copy constructor. More...
| Software (Software &&)=default
| Move constructor. More...
| ~Software () override
| Destructor. More...
Software & | operator= (const Software &)=default
| Assignment operator. More...
Software & | operator= (Software &&) &=default
| Move assignment operator. More...
bool | operator== (const Software &rhs) const
| Equality operator. More...
bool | operator!= (const Software &rhs) const
| Inequality operator. More...
bool | operator< (const Software &rhs) const
| Less-than operator (for sorting) More...
const String & | getName () const
| Returns the name of the software. More...
void | setName (const String &name)
| Sets the name of the software. More...
const String & | getVersion () const
| Returns the software version. More...
void | setVersion (const String &version)
| Sets the software version. 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...
CVTermList & | operator= (const CVTermList &rhs) &=default
| Assignment operator. More...
CVTermList & | operator= (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 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 (MetaInfoInterface &&) noexcept
| Move constructor. More...
| ~MetaInfoInterface ()
| Destructor. More...
MetaInfoInterface & | operator= (const MetaInfoInterface &rhs)
| Assignment operator. More...
MetaInfoInterface & | operator= (MetaInfoInterface &&) noexcept
| Move 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 DataValue &default_value=DataValue::EMPTY) const
| Returns the value corresponding to a string, or a default value (default: DataValue::EMPTY) if not found. More...
const DataValue & | getMetaValue (UInt index, const DataValue &default_value=DataValue::EMPTY) const
| Returns the value corresponding to an index, or a default value (default: 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 | 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...

## Protected Attributes

String | name_
String | version_
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 the software used for processing.

## Constructor & Destructor Documentation

## ◆ Software() [1/3]

Software | ( | const String & | name = `""`,
|  | const String & | version = `""`
| ) |  |

explicit

Constructor.

## ◆ Software() [2/3]

Software | ( | const Software & |  | ) |

default

Copy constructor.

## ◆ Software() [3/3]

Software | ( | Software && |  | ) |

default

Move constructor.

## ◆ ~Software()

~Software | ( |  | ) |

override

Destructor.

## Member Function Documentation

## ◆ getName()

const String& getName | ( |  | ) | const

Returns the name of the software.

## ◆ getVersion()

const String& getVersion | ( |  | ) | const

Returns the software version.

## ◆ operator!=()

bool operator!= | ( | const Software & | rhs | ) | const

Inequality operator.

## ◆ operator<()

bool operator< | ( | const Software & | rhs | ) | const

Less-than operator (for sorting)

## ◆ operator=() [1/2]

Software& operator= | ( | const Software & |  | ) |

default

Assignment operator.

## ◆ operator=() [2/2]

Software& operator= | ( | Software && |  | ) | &

default

Move assignment operator.

## ◆ operator==()

bool operator== | ( | const Software & | rhs | ) | const

Equality operator.

## ◆ setName()

void setName | ( | const String & | name | ) |

Sets the name of the software.

Referenced by XMassFile::load().

## ◆ setVersion()

void setVersion | ( | const String & | version | ) |

Sets the software version.

Referenced by XMassFile::load(), and NucleicAcidSearchEngine::registerIDMetaData_().

## Member Data Documentation

## ◆ name_

String name_

protected

## ◆ version_

String version_

protected