CVTerm Class Reference [Metadata]

Representation of controlled vocabulary term. More...

#include <OpenMS/METADATA/CVTerm.h>

List of all members.

Classes
struct	Unit
Public Member Functions
	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 ()
	Destructor.
CVTerm &	operator= (const CVTerm &rhs)
	Assignment operator.
Accessors
void	setAccession (const String &accession)
	sets the accession string of the term
const String &	getAccession () const
	returns the accession string of the term
void	setName (const String &name)
	sets the name of the term
const String &	getName () const
	returns the name of the term
void	setCVIdentifierRef (const String &cv_identifier_ref)
	sets the cv identifier reference string, e.g. UO for unit obo
const String &	getCVIdentifierRef () const
	returns the cv identifier reference string
void	setValue (const DataValue &value)
	set the value of the term
const DataValue &	getValue () const
	returns the value of the term
void	setUnit (const Unit &unit)
	sets the unit of the term
const Unit &	getUnit () const
	returns the unit
Predicates
String	accession_
String	name_
String	cv_identifier_ref_
Unit	unit_
DataValue	value_
bool	operator== (const CVTerm &rhs) const
	equality operator
bool	operator!= (const CVTerm &rhs) const
	inequality operator
bool	hasValue () const
	checks whether the term has a value
bool	hasUnit () const
	checks whether the term has a unit

---

Detailed Description

Representation of controlled vocabulary term.

This class simply stores a CV term, its value and unit if necessary.Represenation 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]