OpenMS
CVTermListInterface Class Reference

Interface to the controlled vocabulary term list. More...

#include <OpenMS/METADATA/CVTermListInterface.h>

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

Constructors and Assignment

CVTermListcvt_ptr_
 
 CVTermListInterface ()
 
 CVTermListInterface (const CVTermListInterface &rhs)
 Copy constructor. More...
 
 CVTermListInterface (CVTermListInterface &&) noexcept
 Move constructor. More...
 
 ~CVTermListInterface ()
 
CVTermListInterfaceoperator= (const CVTermListInterface &rhs)
 Assignment operator. More...
 
CVTermListInterfaceoperator= (CVTermListInterface &&) noexcept
 Move assignment operator. More...
 
bool operator== (const CVTermListInterface &rhs) const
 equality operator More...
 
bool operator!= (const CVTermListInterface &rhs) const
 inequality operator More...
 
void replaceCVTerms (std::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 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 hasCVTerm (const String &accession) const
 checks whether the term has a value More...
 
bool empty () const
 
void createIfNotExists_ ()
 

Additional Inherited Members

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

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.

Constructor & Destructor Documentation

◆ CVTermListInterface() [1/3]

◆ CVTermListInterface() [2/3]

Copy constructor.

◆ CVTermListInterface() [3/3]

Move constructor.

◆ ~CVTermListInterface()

Member Function Documentation

◆ addCVTerm()

void addCVTerm ( const CVTerm term)

adds a CV term

◆ consumeCVTerms()

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

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

◆ createIfNotExists_()

void createIfNotExists_ ( )
private

◆ empty()

bool empty ( ) const

◆ getCVTerms()

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

returns the accession string of the term

◆ hasCVTerm()

bool hasCVTerm ( const String accession) const

checks whether the term has a value

◆ operator!=()

bool operator!= ( const CVTermListInterface rhs) const

inequality operator

◆ operator=() [1/2]

CVTermListInterface& operator= ( const CVTermListInterface rhs)

Assignment operator.

◆ operator=() [2/2]

CVTermListInterface& operator= ( CVTermListInterface &&  )
noexcept

Move assignment operator.

◆ operator==()

bool operator== ( const CVTermListInterface rhs) const

◆ replaceCVTerm()

void replaceCVTerm ( const CVTerm cv_term)

replaces the specified CV term

◆ replaceCVTerms() [1/3]

void replaceCVTerms ( const std::map< String, std::vector< CVTerm > > &  cv_term_map)

replaces all cv terms with a map (can be obtained via getCVTerms)

◆ replaceCVTerms() [2/3]

void replaceCVTerms ( const std::vector< CVTerm > &  cv_terms,
const String accession 
)

replaces the specified CV terms using the given accession number

◆ replaceCVTerms() [3/3]

void replaceCVTerms ( std::map< String, std::vector< CVTerm > > &  cv_terms)

◆ setCVTerms()

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

sets the CV terms

Member Data Documentation

◆ cvt_ptr_

CVTermList* cvt_ptr_
private