OpenMS  2.6.0
Public Member Functions | Public Attributes | List of all members
ScoreType Struct Reference

Information about a score type. More...

#include <OpenMS/METADATA/ID/ScoreType.h>

Inheritance diagram for ScoreType:
[legend]
Collaboration diagram for ScoreType:
[legend]

Public Member Functions

 ScoreType ()
 
 ScoreType (const CVTerm &cv_term, bool higher_better)
 
 ScoreType (const String &name, bool higher_better)
 
 ScoreType (const ScoreType &other)=default
 
bool operator< (const ScoreType &other) const
 
bool operator== (const ScoreType &other) const
 
- Public Member Functions inherited from MetaInfoInterface
 MetaInfoInterface ()
 Constructor. More...
 
 MetaInfoInterface (const MetaInfoInterface &rhs)
 Copy constructor. More...
 
 MetaInfoInterface (MetaInfoInterface &&) noexcept
 Move constructor. More...
 
 ~MetaInfoInterface ()
 Destructor. More...
 
MetaInfoInterfaceoperator= (const MetaInfoInterface &rhs)
 Assignment operator. More...
 
MetaInfoInterfaceoperator= (MetaInfoInterface &&) noexcept
 Move assignment operator. More...
 
bool operator== (const MetaInfoInterface &rhs) const
 Equality operator. More...
 
bool operator!= (const MetaInfoInterface &rhs) const
 Equality operator. More...
 
const DataValuegetMetaValue (const String &name, const DataValue &default_value=DataValue::EMPTY) const
 Returns the value corresponding to a string, or a default value (default: DataValue::EMPTY) if not found. More...
 
const DataValuegetMetaValue (UInt index, const DataValue &default_value=DataValue::EMPTY) const
 Returns the value corresponding to an index, or a default value (default: DataValue::EMPTY) if not found. More...
 
bool metaValueExists (const String &name) const
 Returns whether an entry with the given name exists. More...
 
bool metaValueExists (UInt index) const
 Returns whether an entry with the given index exists. More...
 
void setMetaValue (const String &name, const DataValue &value)
 Sets the DataValue corresponding to a name. More...
 
void setMetaValue (UInt index, const DataValue &value)
 Sets the DataValue corresponding to an index. More...
 
void removeMetaValue (const String &name)
 Removes the DataValue corresponding to name if it exists. More...
 
void removeMetaValue (UInt index)
 Removes the DataValue corresponding to index if it exists. More...
 
void addMetaValues (const MetaInfoInterface &from)
 function to copy all meta values from one object to this one More...
 
void getKeys (std::vector< String > &keys) const
 Fills the given vector with a list of all keys for which a value is set. More...
 
void getKeys (std::vector< UInt > &keys) const
 Fills the given vector with a list of all keys for which a value is set. More...
 
bool isMetaEmpty () const
 Returns if the MetaInfo is empty. More...
 
void clearMetaInfo ()
 Removes all meta values. More...
 

Public Attributes

CVTerm cv_term
 
bool higher_better
 

Additional Inherited Members

- Static Public Member Functions inherited from MetaInfoInterface
static MetaInfoRegistrymetaRegistry ()
 Returns a reference to the MetaInfoRegistry. More...
 
- Protected Member Functions inherited from MetaInfoInterface
void createIfNotExists_ ()
 Creates the MetaInfo object if it does not exist. More...
 
- Protected Attributes inherited from MetaInfoInterface
MetaInfometa_
 Pointer to the MetaInfo object (0 by default) More...
 

Detailed Description

Information about a score type.

Constructor & Destructor Documentation

◆ ScoreType() [1/4]

ScoreType ( )
inline

◆ ScoreType() [2/4]

ScoreType ( const CVTerm cv_term,
bool  higher_better 
)
inlineexplicit

◆ ScoreType() [3/4]

ScoreType ( const String name,
bool  higher_better 
)
inlineexplicit

◆ ScoreType() [4/4]

ScoreType ( const ScoreType other)
default

Member Function Documentation

◆ operator<()

bool operator< ( const ScoreType other) const
inline

◆ operator==()

bool operator== ( const ScoreType other) const
inline

References ScoreType::cv_term.

Member Data Documentation

◆ cv_term

CVTerm cv_term

◆ higher_better

bool higher_better