Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | List of all members
CVTermList Class Reference

Representation of controlled vocabulary term list. More...

#include <OpenMS/METADATA/CVTermList.h>

Inheritance diagram for CVTermList:
MetaInfoInterface IncludeExcludeTarget Precursor Product ReactionMonitoringTransition Software SourceFile Compound Configuration Contact Instrument Peptide Peptide::Modification Prediction Protein Publication RetentionTime TraMLProduct

Public Member Functions

 CVTermList ()
 Defaults constructor. More...
 
 CVTermList (const CVTermList &rhs)
 Copy constructor. More...
 
virtual ~CVTermList ()
 Destructor. More...
 
CVTermListoperator= (const CVTermList &rhs)
 Assignment operator. More...
 
Accessors
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...
 
- Public Member Functions inherited from MetaInfoInterface
 MetaInfoInterface ()
 constructor More...
 
 MetaInfoInterface (const MetaInfoInterface &rhs)
 copy constructor More...
 
 ~MetaInfoInterface ()
 destructor More...
 
MetaInfoInterfaceoperator= (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 DataValuegetMetaValue (const String &name) const
 returns the value corresponding to a string More...
 
const DataValuegetMetaValue (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...
 

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 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...
 

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...
 
- Protected Attributes inherited from MetaInfoInterface
MetaInfometa_
 pointer to the MetaInfo object. 0 by default More...
 

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 classRepresentation of a CV term used by CVMappings

Constructor & Destructor Documentation

Defaults constructor.

CVTermList ( const CVTermList rhs)

Copy constructor.

virtual ~CVTermList ( )
virtual

Destructor.

Member Function Documentation

void addCVTerm ( const CVTerm term)

adds a CV term

void consumeCVTerms ( const Map< String, std::vector< CVTerm > > &  cv_term_map)

merges the given map into the member map, no duplicate checking

bool empty ( ) const

return true if no terms are available

checks whether the stored terms fulfill a given CVMappingRule TODO : implement

const Map<String, std::vector<CVTerm> >& getCVTerms ( ) const

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)
bool operator== ( const CVTermList cv_term_list) const
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)

void setCVTerms ( const std::vector< CVTerm > &  terms)

sets the CV terms

Member Data Documentation

Map<String, std::vector<CVTerm> > cv_terms_
protected

OpenMS / TOPP release 2.0.0 Documentation generated on Wed Mar 30 2016 12:49:27 using doxygen 1.8.11