USI.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Timo Sachsenberg $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/DATASTRUCTURES/String.h>
#include <OpenMS/config.h>
 
#include <optional>
 
namespace OpenMS
{
  class OPENMS_DLLAPI USI
  {
  public:
    enum class IndexType
    {
      SCAN,    
      INDEX,   
      NATIVEID 
    };
 
 
 
    USI();
 
    USI(const String& collection,
        const String& ms_run,
        IndexType index_type,
        const String& index,
        const String& interpretation = "");
 
    explicit USI(const String& usi_string);
 
    USI(const USI&) = default;
 
    USI(USI&&) noexcept = default;
 
    ~USI() = default;
 
 
 
    USI& operator=(const USI&) = default;
 
    USI& operator=(USI&&) noexcept = default;
 
 
 
    bool operator==(const USI& rhs) const;
 
    bool operator!=(const USI& rhs) const;
 
    bool operator<(const USI& rhs) const;
 
 
 
    bool isValid() const;
 
    static bool isValidUSI(const String& usi_string);
 
    static std::optional<USI> tryParse(const String& usi_string);
 
 
 
    const String& getCollection() const;
 
    void setCollection(const String& collection);
 
    const String& getMSRun() const;
 
    void setMSRun(const String& ms_run);
 
    IndexType getIndexType() const;
 
    void setIndexType(IndexType index_type);
 
    const String& getIndex() const;
 
    void setIndex(const String& index);
 
    const String& getInterpretation() const;
 
    void setInterpretation(const String& interpretation);
 
    bool hasInterpretation() const;
 
 
 
    String toString() const;
 
    bool fromString(const String& usi_string);
 
 
 
    static USI createFromScanNumber(const String& dataset_id,
                                    const String& filename,
                                    int scan_number,
                                    const String& interpretation = "");
 
    static USI createFromNativeID(const String& dataset_id,
                                  const String& filename,
                                  const String& native_id);
 
    static std::optional<int> extractScanNumberFromNativeID(const String& native_id);
 
    static String indexTypeToString(IndexType index_type);
 
    static IndexType indexTypeFromString(const String& type_string);
 
    static String extractBasename(const String& filepath);
 
 
 
    static const String& getCVAccession();
 
    static const String& getCVName();
 
  protected:
    String collection_;      
    String ms_run_;          
    IndexType index_type_;   
    String index_;           
    String interpretation_;  
 
    static const String USI_PREFIX;
 
    static const String CV_ACCESSION;
 
    static const String CV_NAME;
  };
 
  OPENMS_DLLAPI std::ostream& operator<<(std::ostream& os, const USI& usi);
 
} // namespace OpenMS