CVMappingRule Class Reference [Datastructures]

Representation of a CV Mapping rule used by CVMappings. More...

#include <OpenMS/DATASTRUCTURES/CVMappingRule.h>

List of all members.

Public Types
enum	RequirementLevel { MUST = 0, SHOULD = 1, MAY = 2 }
	enum to specify the requirement level More...
enum	CombinationsLogic { OR = 0, AND = 1, XOR = 2 }
	enum to specify the combination operator More...
Public Member Functions
	CVMappingRule ()
	Default constructor.
	CVMappingRule (const CVMappingRule &rhs)
	Copy constructor.
virtual	~CVMappingRule ()
	Destructor.
CVMappingRule &	operator= (const CVMappingRule &rhs)
	Assignment operator.
Accessors
void	setIdentifier (const String &identifier)
	sets the identifier of the rule
const String &	getIdentifier () const
	returns the identifier of the rule
void	setElementPath (const String &element_path)
	sets the path of the element, where this rule is allowed
const String &	getElementPath () const
	returns the path of the element, where this rule is allowed
void	setRequirementLevel (RequirementLevel level)
	sets the requirement level of this rule
RequirementLevel	getRequirementLevel () const
	returns the requirement level of this rule
void	setCombinationsLogic (CombinationsLogic combinations_logic)
	sets the combination operator of the rule
CombinationsLogic	getCombinationsLogic () const
	returns the combinations operator of the rule
void	setScopePath (const String &path)
	sets the scope path of the rule
const String &	getScopePath () const
	returns the scope path of the rule
void	setCVTerms (const std::vector< CVMappingTerm > &cv_terms)
	sets the terms which are allowed
const std::vector < CVMappingTerm > &	getCVTerms () const
	returns the allowed terms
void	addCVTerm (const CVMappingTerm &cv_terms)
	adds a term to the allowed terms
Predicates
bool	operator== (const CVMappingRule &rhs) const
	equality operator
bool	operator!= (const CVMappingRule &rhs) const
	inequality operator
Protected Attributes
String	identifier_
String	element_path_
RequirementLevel	requirement_level_
String	scope_path_
CombinationsLogic	combinations_logic_
std::vector< CVMappingTerm >	cv_terms_

---

Detailed Description

Representation of a CV Mapping rule used by CVMappings.

Representation of a controlled vocabulary mapping rule.

---

Member Enumeration Documentation

enum CombinationsLogic

enum to specify the combination operator

Enumerator:

OR
AND
XOR

enum RequirementLevel

enum to specify the requirement level

Enumerator:

MUST
SHOULD
MAY

---

Constructor & Destructor Documentation

CVMappingRule

(

)

Default constructor.

CVMappingRule

(

const CVMappingRule &

rhs

)

Copy constructor.

virtual ~CVMappingRule

(

)

[virtual]

Destructor.

---

Member Function Documentation

void addCVTerm

(

const CVMappingTerm &

cv_terms

)

adds a term to the allowed terms

CombinationsLogic getCombinationsLogic

(

)

const

returns the combinations operator of the rule

const std::vector<CVMappingTerm>& getCVTerms

(

)

const

returns the allowed terms

const String& getElementPath

(

)

const

returns the path of the element, where this rule is allowed

const String& getIdentifier

(

)

const

returns the identifier of the rule

RequirementLevel getRequirementLevel

(

)

const

returns the requirement level of this rule

const String& getScopePath

(

)

const

returns the scope path of the rule

bool operator!=

(

const CVMappingRule &

rhs

)

const

inequality operator

CVMappingRule& operator=

(

const CVMappingRule &

rhs

)

Assignment operator.

bool operator==

(

const CVMappingRule &

rhs

)

const

equality operator

void setCombinationsLogic

(

CombinationsLogic

combinations_logic

)

sets the combination operator of the rule

void setCVTerms

(

const std::vector< CVMappingTerm > &

cv_terms

)

sets the terms which are allowed

void setElementPath

(

const String &

element_path

)

sets the path of the element, where this rule is allowed

void setIdentifier

(

const String &

identifier

)

sets the identifier of the rule

void setRequirementLevel

(

RequirementLevel

level

)

sets the requirement level of this rule

void setScopePath

(

const String &

path

)

sets the scope path of the rule

---

Member Data Documentation

CombinationsLogic combinations_logic_ [protected]

std::vector<CVMappingTerm> cv_terms_ [protected]

String element_path_ [protected]

String identifier_ [protected]

RequirementLevel requirement_level_ [protected]

String scope_path_ [protected]