OpenMS
Loading...
Searching...
No Matches
OSWIndexTrace Struct Reference

Index path into the OSWData tree from the root down to a specific node. More...

#include <OpenMS/DATASTRUCTURES/OSWData.h>

Collaboration diagram for OSWIndexTrace:
[legend]

Public Member Functions

bool isSet () const
 true if the trace points somewhere (lowest != SIZE_OF_VALUES); false if it is default-constructed.
 

Public Attributes

int idx_prot = -1
 Index into OSWData::getProteins, or -1 if not set.
 
int idx_pep = -1
 Index into the parent protein's getPeptidePrecursors, or -1 if not set.
 
int idx_feat = -1
 Index into the parent precursor's getFeatures, or -1 if not set.
 
int idx_trans = -1
 Index into the parent feature's getTransitionIDs, or -1 if not set.
 
OSWHierarchy::Level lowest = OSWHierarchy::Level::SIZE_OF_VALUES
 Deepest level whose index is meaningful; SIZE_OF_VALUES marks an unset trace.
 

Detailed Description

Index path into the OSWData tree from the root down to a specific node.

If a lower level is set (e.g. idx_feat), every level above it must also be set (the indices form a path through the tree, not arbitrary points). The deepest level whose index is meaningful is recorded in lowest; lowest == SIZE_OF_VALUES is the default-constructed "not pointing anywhere" state.

Member Function Documentation

◆ isSet()

bool isSet ( ) const
inline

true if the trace points somewhere (lowest != SIZE_OF_VALUES); false if it is default-constructed.

Member Data Documentation

◆ idx_feat

int idx_feat = -1

Index into the parent precursor's getFeatures, or -1 if not set.

◆ idx_pep

int idx_pep = -1

Index into the parent protein's getPeptidePrecursors, or -1 if not set.

◆ idx_prot

int idx_prot = -1

Index into OSWData::getProteins, or -1 if not set.

◆ idx_trans

int idx_trans = -1

Index into the parent feature's getTransitionIDs, or -1 if not set.

◆ lowest

Deepest level whose index is meaningful; SIZE_OF_VALUES marks an unset trace.