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 37 of file massspectrumid.h.

Constructor & Destructor Documentation

◆ MassSpectrumId() [1/4]

pappso::MassSpectrumId::MassSpectrumId ( )

Definition at line 31 of file massspectrumid.cpp.

32 {
33 }

◆ MassSpectrumId() [2/4]

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

Definition at line 36 of file massspectrumid.cpp.

37  : mcsp_msRunId(msRunId)
38 {
39 }
MsRunIdCstSPtr mcsp_msRunId

◆ MassSpectrumId() [3/4]

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

Definition at line 42 of file massspectrumid.cpp.

44  : mcsp_msRunId(msRunId), m_nativeId(""), m_spectrumIndex(spectrum_index)
45 {
46 }
std::size_t m_spectrumIndex

◆ MassSpectrumId() [4/4]

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

Definition at line 49 of file massspectrumid.cpp.

50  : mcsp_msRunId(other.mcsp_msRunId),
51  m_nativeId(other.m_nativeId),
52  m_spectrumIndex(other.m_spectrumIndex)
53 {
54 }

◆ ~MassSpectrumId()

pappso::MassSpectrumId::~MassSpectrumId ( )

Definition at line 57 of file massspectrumid.cpp.

58 {
59 }

Member Function Documentation

◆ getMsRunIdCstSPtr()

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

Definition at line 82 of file massspectrumid.cpp.

83 {
84  return mcsp_msRunId;
85 };

References mcsp_msRunId.

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

◆ getNativeId()

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

◆ getSpectrumIndex()

std::size_t pappso::MassSpectrumId::getSpectrumIndex ( ) const

◆ isValid()

bool pappso::MassSpectrumId::isValid ( ) const

Definition at line 124 of file massspectrumid.cpp.

125 {
126  return mcsp_msRunId->isValid() &&
127  m_spectrumIndex != std::numeric_limits<std::size_t>::max();
128 }

References m_spectrumIndex, and mcsp_msRunId.

◆ operator=()

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

Definition at line 63 of file massspectrumid.cpp.

64 {
65  mcsp_msRunId = other.mcsp_msRunId;
66  m_spectrumIndex = other.m_spectrumIndex;
67  m_nativeId = other.m_nativeId;
68 
69  return *this;
70 }

References m_nativeId, m_spectrumIndex, and mcsp_msRunId.

◆ operator==()

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

Definition at line 117 of file massspectrumid.cpp.

118 {
119  return (mcsp_msRunId == other.mcsp_msRunId &&
120  m_spectrumIndex == other.m_spectrumIndex);
121 }

References m_spectrumIndex, and mcsp_msRunId.

◆ setMsRunId()

void pappso::MassSpectrumId::setMsRunId ( MsRunIdCstSPtr  other)

◆ setNativeId()

◆ setSpectrumIndex()

◆ toString()

QString pappso::MassSpectrumId::toString ( ) const

Definition at line 132 of file massspectrumid.cpp.

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

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 49 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 40 of file massspectrumid.h.

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


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