PEFFModification Struct Reference

Represents a PEFF modification annotation. More...

#include <OpenMS/FORMAT/PEFFFile.h>

Collaboration diagram for PEFFModification:

Public Types
enum class	Type { PSI_MOD , UNIMOD , GENERIC }

Public Member Functions
	PEFFModification ()=default
	PEFFModification (Size pos, const String &acc, const String &n, const String &tag="", UInt aid=std::numeric_limits< UInt >::max())
bool	operator== (const PEFFModification &rhs) const

Public Attributes
Size	position {0}
	1-based position, 0 = unknown position (?)
String	accession
	"MOD:00046", "UNIMOD:35", or custom
String	name
	Human-readable name.
String	optional_tag
	Optional tag (last component of annotation tuple)
UInt	annotation_id {std::numeric_limits<UInt>::max()}
	Optional annotation identifier (when HasAnnotationIdentifiers=true), max() = not set.
Type	type {Type::GENERIC}

Detailed Description

Represents a PEFF modification annotation.

PEFF modifications can be in PSI-MOD, UNIMOD, or custom format. Position is 1-based, with 0 indicating unknown position (represented as ? in PEFF).

Member Enumeration Documentation

Type

enum class Type

strong

Enumerator
PSI_MOD
UNIMOD
GENERIC

Constructor & Destructor Documentation

PEFFModification() [1/2]

PEFFModification ( )

default

PEFFModification() [2/2]

PEFFModification ( Size  pos, const String &  acc, const String &  n, const String &  tag = "", UInt  aid = std::numeric_limits<UInt>::max()  )

inline

References String::hasPrefix().

Member Function Documentation

operator==()

bool operator== ( const PEFFModification &  rhs ) const

inline

References PEFFModification::accession, PEFFModification::annotation_id, PEFFModification::name, PEFFModification::optional_tag, PEFFModification::position, and PEFFModification::type.

Member Data Documentation

accession

String accession

"MOD:00046", "UNIMOD:35", or custom

Referenced by PEFFModification::operator==().

annotation_id

UInt annotation_id {std::numeric_limits<UInt>::max()}

Optional annotation identifier (when HasAnnotationIdentifiers=true), max() = not set.

Referenced by PEFFModification::operator==().

name

String name

Human-readable name.

Referenced by PEFFModification::operator==().

optional_tag

String optional_tag

Optional tag (last component of annotation tuple)

Referenced by PEFFModification::operator==().

position

Size position {0}

1-based position, 0 = unknown position (?)

Referenced by PEFFModification::operator==().

type

Type type {Type::GENERIC}

Referenced by PEFFModification::operator==().