Matrix Science Mascot Parser toolkit
 
Loading...
Searching...
No Matches
ms_ms1quant_match_range Class Reference

A range for a component of a peptide match. More...

#include <ms_ms1quant_match_range.hpp>

Inherits ms_handle.

Public Member Functions

 ms_ms1quant_match_range ()
 Default constructor.
 
 ms_ms1quant_match_range (const ms_ms1quant_match_range_body &body)
 Construct a populated ms_ms1quant_match_range.
 
 ms_ms1quant_match_range (int scanId, double rt)
 Construct a range including a single scan.
 
void extend (int scanId, double rt)
 Extend the range.
 
void getRt (double &start, double &end) const
 Get the retention times for the first and last scans.
 
void getScan (int &start, int &end) const
 Get the scan numbers for the first and last scans.
 

Detailed Description

A range for a component of a peptide match.

This is stored in XML in a "range" entity.

Constructor & Destructor Documentation

◆ ms_ms1quant_match_range() [1/2]

Default constructor.

Assigns reasonable default values to all internal members.

◆ ms_ms1quant_match_range() [2/2]

ms_ms1quant_match_range ( const ms_ms1quant_match_range_body &  body)

Construct a populated ms_ms1quant_match_range.

Parameters
bodyThe data loaded from the result file.

Member Function Documentation

◆ getRt()

void getRt ( double &  start,
double &  end 
) const

Get the retention times for the first and last scans.

See Multiple return values in Perl, Java, Python and C#.

Parameters
[out]startFilled in with the retention time of the start of the range.
[out]endFilled in with the retention time of the end of the range.

◆ getScan()

void getScan ( int &  start,
int &  end 
) const

Get the scan numbers for the first and last scans.

See Multiple return values in Perl, Java, Python and C#.

Parameters
[out]startFilled in with the first scan identifier in the range.
[out]endFilled in with the last scan identifier in the range.

The documentation for this class was generated from the following files: