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

Results specific to an 'average' type quantitation method. More...

#include <ms_ms1quant_average_results.hpp>

Inherits ms_handle.

Public Member Functions

 ms_ms1quant_average_results ()
 Default constructor.
 
 ms_ms1quant_average_results (const ms_ms1quant_average_results_body &body)
 Populated constructor, linked to loaded data.
 
int getReferenceHitId () const
 The hit number of the selected reference protein.
 
int getReferenceMemberNumber () const
 The hit-family member number of the selected reference protein.
 
int isReferenceUserSelected () const
 The true if the user selected the reference.
 

Detailed Description

Results specific to an 'average' type quantitation method.

This is stored in a Distiller results XML in an "averageResult" entity.

This is stored in a Distiller results CDB file in an "AverageInfo" stream.

Constructor & Destructor Documentation

◆ ms_ms1quant_average_results() [1/2]

Default constructor.

The default hit identifier is -1.

◆ ms_ms1quant_average_results() [2/2]

ms_ms1quant_average_results ( const ms_ms1quant_average_results_body &  body)

Populated constructor, linked to loaded data.

Parameters
bodyThe data loaded from the result file.

Member Function Documentation

◆ getReferenceHitId()

int getReferenceHitId ( ) const

The hit number of the selected reference protein.

Returns
The hit identifier of the reference protein.

◆ getReferenceMemberNumber()

int getReferenceMemberNumber ( ) const

The hit-family member number of the selected reference protein.

Returns
The family member number of the reference protein.

◆ isReferenceUserSelected()

int isReferenceUserSelected ( ) const

The true if the user selected the reference.

Returns
True if the reference protein was selected by the user, false if it was selected automatically.

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