OpenMS
2.4.0
|
Interface to the controlled vocabulary term list. More...
#include <OpenMS/METADATA/CVTermListInterface.h>
Public Member Functions | |
CVTermListInterface () | |
CVTermListInterface (const CVTermListInterface &rhs) | |
~CVTermListInterface () | |
CVTermListInterface & | operator= (const CVTermListInterface &rhs) |
Assignment operator. More... | |
bool | operator== (const CVTermListInterface &rhs) const |
equality operator More... | |
bool | operator!= (const CVTermListInterface &rhs) const |
inequality operator More... | |
void | replaceCVTerms (Map< String, std::vector< CVTerm > > &cv_terms) |
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 | hasCVTerm (const String &accession) const |
checks whether the term has a value More... | |
bool | empty () const |
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 (or DataValue::EMPTY if not found) More... | |
const DataValue & | getMetaValue (UInt index) const |
Returns the value corresponding to an index (or 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... | |
Private Member Functions | |
void | createIfNotExists_ () |
Private Attributes | |
CVTermList * | cvt_ptr_ |
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... | |
Protected Attributes inherited from MetaInfoInterface | |
MetaInfo * | meta_ |
Pointer to the MetaInfo object (0 by default) More... | |
Interface to the controlled vocabulary term list.
This class is an interface to CVTermList, providing the same interface and it can be used instead (direct plug-in). It can be used to inherit from instead of CVTermList. The advantage is that this class only stores a single pointer to a CVTermList which may be more efficient for an empty list than storing the whole object.Representation of a CV term used by CVMappings
CVTermListInterface | ( | const CVTermListInterface & | rhs | ) |
~CVTermListInterface | ( | ) |
void addCVTerm | ( | const CVTerm & | term | ) |
adds a CV term
merges the given map into the member map, no duplicate checking
|
private |
bool empty | ( | ) | const |
returns the accession string of the term
bool hasCVTerm | ( | const String & | accession | ) | const |
checks whether the term has a value
bool operator!= | ( | const CVTermListInterface & | rhs | ) | const |
inequality operator
CVTermListInterface& operator= | ( | const CVTermListInterface & | rhs | ) |
Assignment operator.
Referenced by RetentionTime::operator=(), Interpretation::operator=(), and TraMLProduct::operator=().
bool operator== | ( | const CVTermListInterface & | rhs | ) | const |
equality operator
Referenced by RetentionTime::operator==(), Interpretation::operator==(), and TraMLProduct::operator==().
void replaceCVTerm | ( | const CVTerm & | cv_term | ) |
replaces the specified CV term
replaces the specified CV terms using the given accession number
replaces all cv terms with a map (can be obtained via getCVTerms)
void setCVTerms | ( | const std::vector< CVTerm > & | terms | ) |
sets the CV terms
|
private |