OpenMS
IDRipper::RipFileIdentifier Struct Reference

Identifies an IDRipper output file. More...

#include <OpenMS/ANALYSIS/ID/IDRipper.h>

Collaboration diagram for IDRipper::RipFileIdentifier:
[legend]

Public Member Functions

 RipFileIdentifier (const IDRipper::IdentificationRuns &id_runs, const PeptideIdentification &pep_id, const std::map< String, UInt > &file_origin_map, const IDRipper::OriginAnnotationFormat origin_annotation_fmt, bool split_ident_runs)
 Constructs a new RipFileIdentifier object. More...
 
UInt getIdentRunIdx () const
 Get identification run index. More...
 
UInt getFileOriginIdx () const
 Get file origin index. More...
 
const StringgetOriginFullname () const
 Get origin full name. More...
 
const StringgetOutputBasename () const
 Get output base name. More...
 

Public Attributes

UInt ident_run_idx {}
 The numerical index of the source IdentificationRun. More...
 
UInt file_origin_idx {}
 The numerical index of the source file_origin / spectra_data element. More...
 
String out_basename
 The output basename derived from the file_origin / spectra_data element. More...
 
String origin_fullname
 The full length origin read from the file_origin / spectra_data element. More...
 

Detailed Description

Identifies an IDRipper output file.

Constructor & Destructor Documentation

◆ RipFileIdentifier()

RipFileIdentifier ( const IDRipper::IdentificationRuns id_runs,
const PeptideIdentification pep_id,
const std::map< String, UInt > &  file_origin_map,
const IDRipper::OriginAnnotationFormat  origin_annotation_fmt,
bool  split_ident_runs 
)

Constructs a new RipFileIdentifier object.

Member Function Documentation

◆ getFileOriginIdx()

UInt getFileOriginIdx ( ) const

Get file origin index.

◆ getIdentRunIdx()

UInt getIdentRunIdx ( ) const

Get identification run index.

◆ getOriginFullname()

const String& getOriginFullname ( ) const

Get origin full name.

◆ getOutputBasename()

const String& getOutputBasename ( ) const

Get output base name.

Member Data Documentation

◆ file_origin_idx

UInt file_origin_idx {}

The numerical index of the source file_origin / spectra_data element.

◆ ident_run_idx

UInt ident_run_idx {}

The numerical index of the source IdentificationRun.

◆ origin_fullname

String origin_fullname

The full length origin read from the file_origin / spectra_data element.

◆ out_basename

String out_basename

The output basename derived from the file_origin / spectra_data element.