Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
ControlledVocabulary::CVTerm Struct Reference

Representation of a CV term. More...

#include <OpenMS/FORMAT/ControlledVocabulary.h>

Public Types

enum  XRefType {
  XSD_STRING = 0, XSD_INTEGER, XSD_DECIMAL, XSD_NEGATIVE_INTEGER,
  XSD_POSITIVE_INTEGER, XSD_NON_NEGATIVE_INTEGER, XSD_NON_POSITIVE_INTEGER, XSD_BOOLEAN,
  XSD_DATE, XSD_ANYURI, NONE
}
 define xsd types allowed in cv term to specify their value-type More...
 

Public Member Functions

 CVTerm ()
 Default constructor. More...
 
 CVTerm (const CVTerm &rhs)
 
CVTermoperator= (const CVTerm &rhs)
 
String toXMLString (const String &ref, const String &value=String("")) const
 get mzidentml formatted string. i.e. a cvparam xml element, ref should be the name of the ControlledVocabulary (i.e. cv.name()) containing the CVTerm (e.g. PSI-MS for the psi-ms.obo - gets loaded in all cases like that??), value can be empty if not available More...
 
String toXMLString (const String &ref, const DataValue &value) const
 get mzidentml formatted string. i.e. a cvparam xml element, ref should be the name of the ControlledVocabulary (i.e. cv.name()) containing the CVTerm (e.g. PSI-MS for the psi-ms.obo - gets loaded in all cases like that??), value can be empty if not available More...
 

Static Public Member Functions

static String getXRefTypeName (XRefType type)
 

Public Attributes

String name
 Text name. More...
 
String id
 Identifier. More...
 
std::set< Stringparents
 The parent IDs. More...
 
std::set< Stringchildren
 The child IDs. More...
 
bool obsolete
 Flag that indicates of the term is obsolete. More...
 
String description
 Term description. More...
 
StringList synonyms
 List of synonyms. More...
 
StringList unparsed
 Unparsed lines from the definition file. More...
 
XRefType xref_type
 xref value-type for the CV-term More...
 
StringList xref_binary
 xref binary-data-type for the CV-term (list of all allowed data value types for the current binary data array) More...
 
std::set< Stringunits
 unit accession ids, defined by relationship has units More...
 

Detailed Description

Representation of a CV term.

Constructor & Destructor Documentation

CVTerm ( )

Default constructor.

CVTerm ( const CVTerm rhs)

Member Function Documentation

static String getXRefTypeName ( XRefType  type)
static
CVTerm& operator= ( const CVTerm rhs)
String toXMLString ( const String ref,
const String value = String("") 
) const

get mzidentml formatted string. i.e. a cvparam xml element, ref should be the name of the ControlledVocabulary (i.e. cv.name()) containing the CVTerm (e.g. PSI-MS for the psi-ms.obo - gets loaded in all cases like that??), value can be empty if not available

String toXMLString ( const String ref,
const DataValue value 
) const

get mzidentml formatted string. i.e. a cvparam xml element, ref should be the name of the ControlledVocabulary (i.e. cv.name()) containing the CVTerm (e.g. PSI-MS for the psi-ms.obo - gets loaded in all cases like that??), value can be empty if not available

Member Data Documentation

std::set<String> children

The child IDs.

String description

Term description.

String id
String name
bool obsolete

Flag that indicates of the term is obsolete.

Referenced by MzMLHandler< MapType >::handleCVParam_().

std::set<String> parents

The parent IDs.

StringList synonyms

List of synonyms.

std::set<String> units

unit accession ids, defined by relationship has units

StringList unparsed

Unparsed lines from the definition file.

StringList xref_binary

xref binary-data-type for the CV-term (list of all allowed data value types for the current binary data array)

XRefType xref_type

xref value-type for the CV-term

Referenced by MzMLHandler< MapType >::handleCVParam_().


OpenMS / TOPP release 2.0.0 Documentation generated on Fri May 29 2015 17:20:36 using doxygen 1.8.9.1