OpenMS  2.7.0
Public Member Functions | List of all members
CVMappingTerm Class Reference

Representation of controlled vocabulary term. More...

#include <OpenMS/DATASTRUCTURES/CVMappingTerm.h>

Collaboration diagram for CVMappingTerm:
[legend]

Public Member Functions

 CVMappingTerm ()
 Defaults constructor. More...
 
 CVMappingTerm (const CVMappingTerm &rhs)
 Copy constructor. More...
 
virtual ~CVMappingTerm ()
 Destructor. More...
 
CVMappingTermoperator= (const CVMappingTerm &rhs)
 Assignment operator. More...
 
Accessors
void setAccession (const String &accession)
 sets the accession string of the term More...
 
const StringgetAccession () const
 returns the accession string of the term More...
 
void setUseTermName (bool use_term_name)
 sets whether the term name should be used, instead of the accession More...
 
bool getUseTermName () const
 returns whether the term name should be used, instead of the accession More...
 
void setUseTerm (bool use_term)
 sets whether the term itself can be used (or only its children) More...
 
bool getUseTerm () const
 returns true if the term can be used, false if only children are allowed More...
 
void setTermName (const String &term_name)
 sets the name of the term More...
 
const StringgetTermName () const
 returns the name of the term More...
 
void setIsRepeatable (bool is_repeatable)
 sets whether this term can be repeated More...
 
bool getIsRepeatable () const
 returns true if this term can be repeated, false otherwise More...
 
void setAllowChildren (bool allow_children)
 sets whether children of this term are allowed More...
 
bool getAllowChildren () const
 returns true if the children of this term are allowed to be used More...
 
void setCVIdentifierRef (const String &cv_identifier_ref)
 sets the cv identifier reference string, e.g. UO for unit obo More...
 
const StringgetCVIdentifierRef () const
 returns the cv identifier reference string More...
 

Predicates

String accession_
 
bool use_term_name_
 
bool use_term_
 
String term_name_
 
bool is_repeatable_
 
bool allow_children_
 
String cv_identifier_ref_
 
bool operator== (const CVMappingTerm &rhs) const
 equality operator More...
 
bool operator!= (const CVMappingTerm &rhs) const
 inequality operator More...
 

Detailed Description

Representation of controlled vocabulary term.

This class simply stores CV terms read from e.g. an OBO-file Representation of a CV term used by CVMappings

Constructor & Destructor Documentation

◆ CVMappingTerm() [1/2]

Defaults constructor.

◆ CVMappingTerm() [2/2]

CVMappingTerm ( const CVMappingTerm rhs)

Copy constructor.

◆ ~CVMappingTerm()

virtual ~CVMappingTerm ( )
virtual

Destructor.

Member Function Documentation

◆ getAccession()

const String& getAccession ( ) const

returns the accession string of the term

◆ getAllowChildren()

bool getAllowChildren ( ) const

returns true if the children of this term are allowed to be used

◆ getCVIdentifierRef()

const String& getCVIdentifierRef ( ) const

returns the cv identifier reference string

◆ getIsRepeatable()

bool getIsRepeatable ( ) const

returns true if this term can be repeated, false otherwise

◆ getTermName()

const String& getTermName ( ) const

returns the name of the term

◆ getUseTerm()

bool getUseTerm ( ) const

returns true if the term can be used, false if only children are allowed

◆ getUseTermName()

bool getUseTermName ( ) const

returns whether the term name should be used, instead of the accession

◆ operator!=()

bool operator!= ( const CVMappingTerm rhs) const

inequality operator

◆ operator=()

CVMappingTerm& operator= ( const CVMappingTerm rhs)

Assignment operator.

◆ operator==()

bool operator== ( const CVMappingTerm rhs) const

equality operator

◆ setAccession()

void setAccession ( const String accession)

sets the accession string of the term

◆ setAllowChildren()

void setAllowChildren ( bool  allow_children)

sets whether children of this term are allowed

◆ setCVIdentifierRef()

void setCVIdentifierRef ( const String cv_identifier_ref)

sets the cv identifier reference string, e.g. UO for unit obo

◆ setIsRepeatable()

void setIsRepeatable ( bool  is_repeatable)

sets whether this term can be repeated

◆ setTermName()

void setTermName ( const String term_name)

sets the name of the term

◆ setUseTerm()

void setUseTerm ( bool  use_term)

sets whether the term itself can be used (or only its children)

◆ setUseTermName()

void setUseTermName ( bool  use_term_name)

sets whether the term name should be used, instead of the accession

Member Data Documentation

◆ accession_

String accession_
protected

◆ allow_children_

bool allow_children_
protected

◆ cv_identifier_ref_

String cv_identifier_ref_
protected

◆ is_repeatable_

bool is_repeatable_
protected

◆ term_name_

String term_name_
protected

◆ use_term_

bool use_term_
protected

◆ use_term_name_

bool use_term_name_
protected