PEFFDatabaseMetadata Struct Reference

Metadata from a PEFF database header section. More...

#include <OpenMS/FORMAT/PEFFFile.h>

Collaboration diagram for PEFFDatabaseMetadata:

Public Types
enum class	SequenceType { AA , NA }

Public Member Functions
	PEFFDatabaseMetadata ()=default
bool	operator== (const PEFFDatabaseMetadata &rhs) const

Public Attributes
std::string	version {"1.0"}
std::string	db_name
std::string	prefix
std::string	db_description
bool	is_decoy {false}
std::vector< std::string >	db_sources
std::string	db_version
Size	number_of_entries {0}
SequenceType	sequence_type {SequenceType::AA}
std::vector< std::string >	general_comments
	Multiple GeneralComment lines allowed.
std::string	conversion
	Conversion notes.
std::map< std::string, std::string >	specific_keys
	SpecificKey definitions (key -> description)
std::map< std::string, std::string >	specific_values
	SpecificValue definitions (key -> type)
std::vector< std::string >	optional_tag_defs
std::vector< PEFFCustomKeyDef >	custom_key_defs
	CustomKeyDef definitions.
bool	has_annotation_identifiers {false}
	Whether entries use annotation identifiers.
bool	is_proteoform_db {false}
	Whether this is a proteoform database (ProteoformDb)
std::map< std::string, std::string >	unrecognized_keys
	Unrecognized header keys (preserved for round-trip)

Detailed Description

Metadata from a PEFF database header section.

The header section contains lines starting with # that describe the database.

Member Enumeration Documentation

SequenceType

enum class SequenceType

strong

Enumerator
AA
NA

Constructor & Destructor Documentation

PEFFDatabaseMetadata()

PEFFDatabaseMetadata ( )

default

Member Function Documentation

operator==()

bool operator== ( const PEFFDatabaseMetadata &  rhs ) const

inline

References PEFFDatabaseMetadata::conversion, PEFFDatabaseMetadata::custom_key_defs, PEFFDatabaseMetadata::db_description, PEFFDatabaseMetadata::db_name, PEFFDatabaseMetadata::db_sources, PEFFDatabaseMetadata::db_version, PEFFDatabaseMetadata::general_comments, PEFFDatabaseMetadata::has_annotation_identifiers, PEFFDatabaseMetadata::is_decoy, PEFFDatabaseMetadata::is_proteoform_db, PEFFDatabaseMetadata::number_of_entries, PEFFDatabaseMetadata::optional_tag_defs, PEFFDatabaseMetadata::prefix, PEFFDatabaseMetadata::sequence_type, PEFFDatabaseMetadata::specific_keys, PEFFDatabaseMetadata::specific_values, PEFFDatabaseMetadata::unrecognized_keys, and PEFFDatabaseMetadata::version.

Member Data Documentation

conversion

std::string conversion

Conversion notes.

Referenced by PEFFDatabaseMetadata::operator==().

custom_key_defs

std::vector<PEFFCustomKeyDef> custom_key_defs

CustomKeyDef definitions.

Referenced by PEFFDatabaseMetadata::operator==().

db_description

std::string db_description

Referenced by PEFFDatabaseMetadata::operator==().

db_name

std::string db_name

Referenced by PEFFDatabaseMetadata::operator==().

db_sources

std::vector<std::string> db_sources

Referenced by PEFFDatabaseMetadata::operator==().

db_version

std::string db_version

Referenced by PEFFDatabaseMetadata::operator==().

general_comments

std::vector<std::string> general_comments

Multiple GeneralComment lines allowed.

Referenced by PEFFDatabaseMetadata::operator==().

has_annotation_identifiers

bool has_annotation_identifiers {false}

Whether entries use annotation identifiers.

Referenced by PEFFDatabaseMetadata::operator==().

is_decoy

bool is_decoy {false}

Referenced by PEFFDatabaseMetadata::operator==().

is_proteoform_db

bool is_proteoform_db {false}

Whether this is a proteoform database (ProteoformDb)

Referenced by PEFFDatabaseMetadata::operator==().

number_of_entries

Size number_of_entries {0}

Referenced by PEFFDatabaseMetadata::operator==().

optional_tag_defs

std::vector<std::string> optional_tag_defs

Referenced by PEFFDatabaseMetadata::operator==().

prefix

std::string prefix

Referenced by PEFFDatabaseMetadata::operator==().

sequence_type

SequenceType sequence_type {SequenceType::AA}

Referenced by PEFFDatabaseMetadata::operator==().

specific_keys

std::map<std::string, std::string> specific_keys

SpecificKey definitions (key -> description)

Referenced by PEFFDatabaseMetadata::operator==().

specific_values

std::map<std::string, std::string> specific_values

SpecificValue definitions (key -> type)

Referenced by PEFFDatabaseMetadata::operator==().

unrecognized_keys

std::map<std::string, std::string> unrecognized_keys

Unrecognized header keys (preserved for round-trip)

Referenced by PEFFDatabaseMetadata::operator==().

version

std::string version {"1.0"}

Referenced by PEFFDatabaseMetadata::operator==().