Representation of controlled vocabulary term list. More...
#include <OpenMS/METADATA/CVTermList.h>
Public Member Functions | |
| CVTermList () | |
| Defaults constructor. | |
| CVTermList (const CVTermList &rhs) | |
| Copy constructor. | |
| virtual | ~CVTermList () |
| Destructor. | |
| CVTermList & | operator= (const CVTermList &rhs) |
| Assignment operator. | |
Accessors | |
| void | setCVTerms (const std::vector< CVTerm > &terms) |
| sets the CV terms | |
| void | replaceCVTerm (const CVTerm &cv_term) |
| replaces the specified CV term | |
| void | replaceCVTerms (const std::vector< CVTerm > &cv_terms, const String &accession) |
| replaces the specified CV terms using the given accession number | |
| void | replaceCVTerms (const Map< String, std::vector< CVTerm > > &cv_term_map) |
| replaces all cv terms with a map (can be obtained via getCVTerms) | |
| const Map< String, std::vector < CVTerm > > & | getCVTerms () const |
| returns the accession string of the term | |
| void | addCVTerm (const CVTerm &term) |
| adds a CV term | |
Predicates | |
checks whether the spellings of the CV terms stored are correct corrects the CVTerm names, according to the loaded CV | |
| Map< String, std::vector < CVTerm > > | cv_terms_ |
| bool | operator== (const CVTermList &cv_term_list) const |
| equality operator | |
| bool | operator!= (const CVTermList &cv_term_list) const |
| inequality operator | |
| bool | hasCVTerm (const String &accession) const |
| checks whether the term has a value | |
| bool | checkCVTerms (const CVMappingRule &rule, const ControlledVocabulary &cv) const |
| checks whether the stored terms fullfil a given CVMappingRule | |
| bool | empty () const |
| return true if no terms are available | |
Detailed Description
Representation of controlled vocabulary term list.
This class should be used to inherit from, to allow to add an arbitrary number of CV terms to the inherited classRepresenation of a CV term used by CVMappings
Constructor & Destructor Documentation
| CVTermList | ( | ) |
Defaults constructor.
| CVTermList | ( | const CVTermList & | rhs | ) |
Copy constructor.
| virtual ~CVTermList | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| void addCVTerm | ( | const CVTerm & | term | ) |
adds a CV term
| bool checkCVTerms | ( | const CVMappingRule & | rule, | |
| const ControlledVocabulary & | cv | |||
| ) | const |
checks whether the stored terms fullfil a given CVMappingRule
| bool empty | ( | ) | const |
return true if no terms are available
returns the accession string of the term
| bool hasCVTerm | ( | const String & | accession | ) | const |
checks whether the term has a value
| bool operator!= | ( | const CVTermList & | cv_term_list | ) | const |
inequality operator
| CVTermList& operator= | ( | const CVTermList & | rhs | ) |
Assignment operator.
Referenced by TraMLProduct::operator=(), Prediction::operator=(), Instrument::operator=(), Publication::operator=(), Contact::operator=(), Peptide::operator=(), Compound::operator=(), and RetentionTime::operator=().
| bool operator== | ( | const CVTermList & | cv_term_list | ) | const |
equality operator
Referenced by TraMLProduct::operator==(), Prediction::operator==(), Instrument::operator==(), Publication::operator==(), Contact::operator==(), Peptide::operator==(), Compound::operator==(), and RetentionTime::operator==().
| void replaceCVTerm | ( | const CVTerm & | cv_term | ) |
replaces the specified CV term
replaces all cv terms with a map (can be obtained via getCVTerms)
replaces the specified CV terms using the given accession number
| void setCVTerms | ( | const std::vector< CVTerm > & | terms | ) |
sets the CV terms
Member Data Documentation
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:55 using doxygen 1.7.1 |