ProteoWizard
Public Member Functions | Public Attributes | List of all members
pwiz::msdata::ChromatogramIdentity Struct Reference

Identifying information for a chromatogram. More...

#include <MSData.hpp>

Inheritance diagram for pwiz::msdata::ChromatogramIdentity:
pwiz::msdata::Chromatogram

Public Member Functions

 ChromatogramIdentity ()
 

Public Attributes

size_t index
 the zero-based, consecutive index of the chromatogram in the ChromatogramList.
 
std::string id
 a unique identifier for this chromatogram. It should be expected that external files may use this identifier together with the mzML filename or accession to reference a particular chromatogram.
 
boost::iostreams::stream_offset sourceFilePosition
 for file-based MSData implementations, this attribute may refer to the chromatogram's position in the file
 

Detailed Description

Identifying information for a chromatogram.

Definition at line 489 of file MSData.hpp.

Constructor & Destructor Documentation

◆ ChromatogramIdentity()

pwiz::msdata::ChromatogramIdentity::ChromatogramIdentity ( )
inline

Definition at line 500 of file MSData.hpp.

const size_t IDENTITY_INDEX_NONE
Definition MSData.hpp:467
size_t index
the zero-based, consecutive index of the chromatogram in the ChromatogramList.
Definition MSData.hpp:492
boost::iostreams::stream_offset sourceFilePosition
for file-based MSData implementations, this attribute may refer to the chromatogram's position in the...
Definition MSData.hpp:498

References pwiz::msdata::IDENTITY_INDEX_NONE.

Member Data Documentation

◆ index

size_t pwiz::msdata::ChromatogramIdentity::index

the zero-based, consecutive index of the chromatogram in the ChromatogramList.

Definition at line 492 of file MSData.hpp.

Referenced by EvenPredicate::accept(), SelectedIndexPredicate::accept(), initializeTestData(), pwiz::msdata::TextWriter::operator()(), test(), and testChromatogram().

◆ id

std::string pwiz::msdata::ChromatogramIdentity::id

a unique identifier for this chromatogram. It should be expected that external files may use this identifier together with the mzML filename or accession to reference a particular chromatogram.

Definition at line 495 of file MSData.hpp.

Referenced by initializeTestData(), pwiz::msdata::TextWriter::operator()(), test(), and testChromatogram().

◆ sourceFilePosition

boost::iostreams::stream_offset pwiz::msdata::ChromatogramIdentity::sourceFilePosition

for file-based MSData implementations, this attribute may refer to the chromatogram's position in the file

Definition at line 498 of file MSData.hpp.

Referenced by testChromatogram().


The documentation for this struct was generated from the following file: