CVMappings Class Reference [Format]

Representation of controlled vocabulary mapping rules (for PSI formats). More...

#include <OpenMS/DATASTRUCTURES/CVMappings.h>

List of all members.

Public Member Functions
	CVMappings ()
	Default constructor.
	CVMappings (const CVMappings &rhs)
	Copy constructor.
virtual	~CVMappings ()
	Destructor.
CVMappings &	operator= (const CVMappings &rhs)
	Assignment operator.
Accessors
void	setMappingRules (const std::vector< CVMappingRule > &cv_mapping_rules)
	sets the mapping rules of the mapping file
const std::vector < CVMappingRule > &	getMappingRules () const
	returns the mapping rules
void	addMappingRule (const CVMappingRule &cv_mapping_rule)
	adds a mapping rule
void	setCVReferences (const std::vector< CVReference > &cv_references)
	sets the CV references
const std::vector< CVReference > &	getCVReferences () const
	returns the CV references
void	addCVReference (const CVReference &cv_reference)
	adds a CV reference
Predicates
bool	hasCVReference (const String &identifier)
	returns true if a CV reference is given
bool	operator== (const CVMappings &rhs) const
	equality operator
bool	operator!= (const CVMappings &rhs) const
	inequality operator
Protected Attributes
std::vector< CVMappingRule >	mapping_rules_
Map< String, CVReference >	cv_references_
std::vector< CVReference >	cv_references_vector_

---

Detailed Description

Representation of controlled vocabulary mapping rules (for PSI formats).

This file serves as object for the controlled vocabulary term usage definitions used in CV-Mapping files. All the supported attributes supported in the mapping file are supported by this class.

---

Constructor & Destructor Documentation

CVMappings

(

)

Default constructor.

CVMappings

(

const CVMappings &

rhs

)

Copy constructor.

virtual ~CVMappings

(

)

[virtual]

Destructor.

---

Member Function Documentation

void addCVReference

(

const CVReference &

cv_reference

)

adds a CV reference

void addMappingRule

(

const CVMappingRule &

cv_mapping_rule

)

adds a mapping rule

const std::vector<CVReference>& getCVReferences

(

)

const

returns the CV references

const std::vector<CVMappingRule>& getMappingRules

(

)

const

returns the mapping rules

bool hasCVReference

(

const String &

identifier

)

returns true if a CV reference is given

bool operator!=

(

const CVMappings &

rhs

)

const

inequality operator

CVMappings& operator=

(

const CVMappings &

rhs

)

Assignment operator.

bool operator==

(

const CVMappings &

rhs

)

const

equality operator

void setCVReferences

(

const std::vector< CVReference > &

cv_references

)

sets the CV references

void setMappingRules

(

const std::vector< CVMappingRule > &

cv_mapping_rules

)

sets the mapping rules of the mapping file

---

Member Data Documentation

Map<String, CVReference> cv_references_ [protected]

std::vector<CVReference> cv_references_vector_ [protected]

std::vector<CVMappingRule> mapping_rules_ [protected]