libpappsomspp
Library for mass spectrometry
pappso::MassSpectrumId Class Reference

#include <massspectrumid.h>

Public Member Functions

 MassSpectrumId ()
 
 MassSpectrumId (const MsRunIdCstSPtr &msrun_id)
 
 MassSpectrumId (const MsRunIdCstSPtr &msrun_id, std::size_t spectrum_index)
 
 MassSpectrumId (const MassSpectrumId &other)
 
 ~MassSpectrumId ()
 
MassSpectrumIdoperator= (const MassSpectrumId &other)
 
void setMsRunId (MsRunIdCstSPtr other)
 
const MsRunIdCstSPtrgetMsRunIdCstSPtr () const
 
void setNativeId (const QString &native_id)
 
const QString & getNativeId () const
 
void setSpectrumIndex (std::size_t index)
 
std::size_t getSpectrumIndex () const
 
bool operator== (const MassSpectrumId &other) const
 
bool isValid () const
 
QString toString () const
 

Private Attributes

MsRunIdCstSPtr mcsp_msRunId = nullptr
 
QString m_nativeId
 
std::size_t m_spectrumIndex = std::numeric_limits<std::size_t>::max()
 

Detailed Description

Definition at line 39 of file massspectrumid.h.

Constructor & Destructor Documentation

◆ MassSpectrumId() [1/4]

pappso::MassSpectrumId::MassSpectrumId ( )

Definition at line 34 of file massspectrumid.cpp.

35 {
36 }

◆ MassSpectrumId() [2/4]

pappso::MassSpectrumId::MassSpectrumId ( const MsRunIdCstSPtr msrun_id)

Definition at line 39 of file massspectrumid.cpp.

40  : mcsp_msRunId(msRunId)
41 {
42 }
MsRunIdCstSPtr mcsp_msRunId

◆ MassSpectrumId() [3/4]

pappso::MassSpectrumId::MassSpectrumId ( const MsRunIdCstSPtr msrun_id,
std::size_t  spectrum_index 
)

Definition at line 45 of file massspectrumid.cpp.

47  : mcsp_msRunId(msRunId), m_nativeId(""), m_spectrumIndex(spectrum_index)
48 {
49 }
std::size_t m_spectrumIndex

◆ MassSpectrumId() [4/4]

pappso::MassSpectrumId::MassSpectrumId ( const MassSpectrumId other)

Definition at line 52 of file massspectrumid.cpp.

53  : mcsp_msRunId(other.mcsp_msRunId),
54  m_nativeId(other.m_nativeId),
55  m_spectrumIndex(other.m_spectrumIndex)
56 {
57 }

◆ ~MassSpectrumId()

pappso::MassSpectrumId::~MassSpectrumId ( )

Definition at line 60 of file massspectrumid.cpp.

61 {
62 }

Member Function Documentation

◆ getMsRunIdCstSPtr()

const MsRunIdCstSPtr & pappso::MassSpectrumId::getMsRunIdCstSPtr ( ) const

Definition at line 85 of file massspectrumid.cpp.

86 {
87  return mcsp_msRunId;
88 };

References mcsp_msRunId.

Referenced by pappso::MgfOutput::write().

◆ getNativeId()

const QString & pappso::MassSpectrumId::getNativeId ( ) const

◆ getSpectrumIndex()

◆ isValid()

bool pappso::MassSpectrumId::isValid ( ) const

Definition at line 127 of file massspectrumid.cpp.

128 {
129  return mcsp_msRunId->isValid() &&
130  m_spectrumIndex != std::numeric_limits<std::size_t>::max();
131 }

References m_spectrumIndex, and mcsp_msRunId.

◆ operator=()

MassSpectrumId & pappso::MassSpectrumId::operator= ( const MassSpectrumId other)

Definition at line 66 of file massspectrumid.cpp.

67 {
68  mcsp_msRunId = other.mcsp_msRunId;
69  m_spectrumIndex = other.m_spectrumIndex;
70  m_nativeId = other.m_nativeId;
71 
72  return *this;
73 }

References m_nativeId, m_spectrumIndex, and mcsp_msRunId.

◆ operator==()

bool pappso::MassSpectrumId::operator== ( const MassSpectrumId other) const

Definition at line 120 of file massspectrumid.cpp.

121 {
122  return (mcsp_msRunId == other.mcsp_msRunId &&
123  m_spectrumIndex == other.m_spectrumIndex);
124 }

References m_spectrumIndex, and mcsp_msRunId.

◆ setMsRunId()

◆ setNativeId()

◆ setSpectrumIndex()

◆ toString()

QString pappso::MassSpectrumId::toString ( ) const

Definition at line 135 of file massspectrumid.cpp.

136 {
137  return QString(
138  "ms run id: %1 \n"
139  "native id: %2 \n"
140  "m_spectrumIndex: %3\n")
141  .arg(mcsp_msRunId != nullptr ? mcsp_msRunId->toString() : "nullptr")
142  .arg(m_nativeId)
143  .arg(m_spectrumIndex);
144 }

References m_nativeId, m_spectrumIndex, and mcsp_msRunId.

Referenced by pappso::QualifiedMassSpectrum::toString().

Member Data Documentation

◆ m_nativeId

QString pappso::MassSpectrumId::m_nativeId
private

Definition at line 51 of file massspectrumid.h.

Referenced by getNativeId(), operator=(), setNativeId(), and toString().

◆ m_spectrumIndex

std::size_t pappso::MassSpectrumId::m_spectrumIndex = std::numeric_limits<std::size_t>::max()
private

◆ mcsp_msRunId

MsRunIdCstSPtr pappso::MassSpectrumId::mcsp_msRunId = nullptr
private

Definition at line 42 of file massspectrumid.h.

Referenced by getMsRunIdCstSPtr(), isValid(), operator=(), operator==(), setMsRunId(), and toString().


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