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

Representation of controlled vocabulary term. More...

#include <OpenMS/METADATA/CVTerm.h>

Classes

struct  Unit
 

Public Member Functions

 CVTerm ()
 Default constructor. More...
 
 CVTerm (const String &accession, const String &name, const String &cv_identifier_ref, const String &value, const Unit &unit)
 Detailed constructor. More...
 
 CVTerm (const CVTerm &rhs)
 Copy constructor. More...
 
virtual ~CVTerm ()
 Destructor. More...
 
CVTermoperator= (const CVTerm &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 setName (const String &name)
 sets the name of the term More...
 
const StringgetName () const
 returns the name of the term 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...
 
void setValue (const DataValue &value)
 set the value of the term More...
 
const DataValuegetValue () const
 returns the value of the term More...
 
void setUnit (const Unit &unit)
 sets the unit of the term More...
 
const UnitgetUnit () const
 returns the unit More...
 

Predicates

String accession_
 
String name_
 
String cv_identifier_ref_
 
Unit unit_
 
DataValue value_
 
bool operator== (const CVTerm &rhs) const
 equality operator More...
 
bool operator!= (const CVTerm &rhs) const
 inequality operator More...
 
bool hasValue () const
 checks whether the term has a value More...
 
bool hasUnit () const
 checks whether the term has a unit More...
 

Detailed Description

Representation of controlled vocabulary term.

This class simply stores a CV term, its value and unit if necessary.Representation of a CV term used by CVMappings

Constructor & Destructor Documentation

CVTerm ( )

Default constructor.

CVTerm ( const String accession,
const String name,
const String cv_identifier_ref,
const String value,
const Unit unit 
)

Detailed constructor.

CVTerm ( const CVTerm rhs)

Copy constructor.

virtual ~CVTerm ( )
virtual

Destructor.

Member Function Documentation

const String& getAccession ( ) const

returns the accession string of the term

const String& getCVIdentifierRef ( ) const

returns the cv identifier reference string

const String& getName ( ) const

returns the name of the term

const Unit& getUnit ( ) const

returns the unit

const DataValue& getValue ( ) const

returns the value of the term

bool hasUnit ( ) const

checks whether the term has a unit

bool hasValue ( ) const

checks whether the term has a value

bool operator!= ( const CVTerm rhs) const

inequality operator

CVTerm& operator= ( const CVTerm rhs)

Assignment operator.

bool operator== ( const CVTerm rhs) const

equality operator

void setAccession ( const String accession)

sets the accession string of the term

void setCVIdentifierRef ( const String cv_identifier_ref)

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

void setName ( const String name)

sets the name of the term

void setUnit ( const Unit unit)

sets the unit of the term

void setValue ( const DataValue value)

set the value of the term

Member Data Documentation

String accession_
protected
String cv_identifier_ref_
protected
String name_
protected
Unit unit_
protected
DataValue value_
protected

OpenMS / TOPP release 2.0.0 Documentation generated on Sat May 16 2015 16:13:47 using doxygen 1.8.9.1