FWCore/Utilities/interface/RunIndex.h - master - githubmirror/cmssw

FWCore/Utilities/interface/RunIndex.h

61 строка2 KB

Christopher Jones

Fix `scram b code-checks` warnings associated with FWCore

08 сен 2020, 22:04

08 сен 2020, 22:0424df5ff

#ifndef FWCore_Utilities_RunIndex_h
#define FWCore_Utilities_RunIndex_h
// -*- C++ -*-
//
// Package:     FWCore/Utilities
// Class  :     edm::RunIndex
//
/**\class edm::RunIndex RunIndex.h "FWCore/Utilities/interface/RunIndex.h"

 Description: Identifies a 'slot' being used to hold an active Run

 Usage:
    Various APIs used this to access per Run information.
 It is important to realize that the same RunIndex may be used to refer
 to different Runs over the lifetime of a job. An RunIndex will only get
 a new Run after the previous Run using that index has finished being used.

*/
//
// Original Author:  Chris Jones
//         Created:  Fri, 26 Apr 2013 19:38:56 GMT
//

// system include files

// user include files

// forward declarations
namespace edm {
  class RunPrincipal;

  class RunIndex {
  public:
    ~RunIndex() = default;
    RunIndex() = delete;
    RunIndex(const RunIndex&) = default;
    RunIndex& operator=(const RunIndex&) = default;

    // ---------- const member functions ---------------------
    bool operator==(const RunIndex& iIndex) const { return value() == iIndex.value(); }
    operator unsigned int() const { return value_; }

    /** \return value ranging from 0 to one less than max number of simultaneous runs.
     */
    unsigned int value() const { return value_; }

    static RunIndex invalidRunIndex();

  private:
    ///Only the RunPrincipal is allowed to make one of these
    friend class RunPrincipal;
    explicit RunIndex(unsigned int iIndex) : value_(iIndex) {}

    // ---------- member data --------------------------------
    unsigned int value_;

    static const unsigned int invalidValue_;
  };
}  // namespace edm

#endif