OpenMS  2.6.0
Public Member Functions | List of all members
CVMappings Class Reference

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

#include <OpenMS/DATASTRUCTURES/CVMappings.h>

Collaboration diagram for CVMappings:

Public Member Functions

 CVMappings ()
 Default constructor. More...
 CVMappings (const CVMappings &rhs)
 Copy constructor. More...
virtual ~CVMappings ()
 Destructor. More...
CVMappingsoperator= (const CVMappings &rhs)
 Assignment operator. More...
void setMappingRules (const std::vector< CVMappingRule > &cv_mapping_rules)
 sets the mapping rules of the mapping file More...
const std::vector< CVMappingRule > & getMappingRules () const
 returns the mapping rules More...
void addMappingRule (const CVMappingRule &cv_mapping_rule)
 adds a mapping rule More...
void setCVReferences (const std::vector< CVReference > &cv_references)
 sets the CV references More...
const std::vector< CVReference > & getCVReferences () const
 returns the CV references More...
void addCVReference (const CVReference &cv_reference)
 adds a CV reference More...


std::vector< CVMappingRulemapping_rules_
std::map< String, CVReferencecv_references_
std::vector< CVReferencecv_references_vector_
bool hasCVReference (const String &identifier)
 returns true if a CV reference is given More...
bool operator== (const CVMappings &rhs) const
 equality operator More...
bool operator!= (const CVMappings &rhs) const
 inequality operator More...

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() [1/2]

Default constructor.

◆ CVMappings() [2/2]

CVMappings ( const CVMappings rhs)

Copy constructor.

◆ ~CVMappings()

virtual ~CVMappings ( )


Member Function Documentation

◆ addCVReference()

void addCVReference ( const CVReference cv_reference)

adds a CV reference

◆ addMappingRule()

void addMappingRule ( const CVMappingRule cv_mapping_rule)

adds a mapping rule

◆ getCVReferences()

const std::vector<CVReference>& getCVReferences ( ) const

returns the CV references

◆ getMappingRules()

const std::vector<CVMappingRule>& getMappingRules ( ) const

returns the mapping rules

◆ hasCVReference()

bool hasCVReference ( const String identifier)

returns true if a CV reference is given

◆ operator!=()

bool operator!= ( const CVMappings rhs) const

inequality operator

◆ operator=()

CVMappings& operator= ( const CVMappings rhs)

Assignment operator.

◆ operator==()

bool operator== ( const CVMappings rhs) const

equality operator

◆ setCVReferences()

void setCVReferences ( const std::vector< CVReference > &  cv_references)

sets the CV references

◆ setMappingRules()

void setMappingRules ( const std::vector< CVMappingRule > &  cv_mapping_rules)

sets the mapping rules of the mapping file

Member Data Documentation

◆ cv_references_

std::map<String, CVReference> cv_references_

◆ cv_references_vector_

std::vector<CVReference> cv_references_vector_

◆ mapping_rules_

std::vector<CVMappingRule> mapping_rules_