CCDBParamSpec.cxx

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
#include "Framework/CCDBParamSpec.h"
#include <fmt/format.h>
#include <algorithm>
 
namespace o2::framework
{
 
ConfigParamSpec ccdbPathSpec(std::string const& path)
{
  return ConfigParamSpec{"ccdb-path", VariantType::String, path, {fmt::format("Path in CCDB ({})", path)}, ConfigParamKind::kGeneric};
}
 
ConfigParamSpec ccdbRunDependent(int defaultValue)
{
  return ConfigParamSpec{"ccdb-run-dependent", VariantType::Int, defaultValue, {"Give object for specific run number"}, ConfigParamKind::kGeneric};
}
 
ConfigParamSpec ccdbQueryRateSpec(int r)
{
  return ConfigParamSpec{"ccdb-query-rate", VariantType::Int, r, {"Query after once every N TFs"}, ConfigParamKind::kGeneric};
}
 
ConfigParamSpec ccdbMetadataSpec(std::string const& key, std::string const& defaultValue)
{
  return ConfigParamSpec{fmt::format("ccdb-metadata-{}", key),
                         VariantType::String,
                         defaultValue,
                         {fmt::format("CCDB metadata {}", key)},
                         ConfigParamKind::kGeneric};
}
 
std::vector<ConfigParamSpec> ccdbParamSpec(std::string const& path, std::vector<CCDBMetadata> metadata, int qrate)
{
  return ccdbParamSpec(path, false, metadata, qrate);
}
 
std::vector<ConfigParamSpec> ccdbParamSpec(std::string const& path, int runDependent, std::vector<CCDBMetadata> metadata, int qrate)
{
  // Add here CCDB objecs which should be considered run dependent
  std::vector<ConfigParamSpec> result{ccdbPathSpec(path)};
  if (runDependent > 0) {
    result.push_back(ccdbRunDependent(runDependent));
  }
  if (qrate != 0) {
    result.push_back(ccdbQueryRateSpec(qrate < 0 ? std::numeric_limits<int>::max() : qrate));
  }
  for (auto& [key, value] : metadata) {
    result.push_back(ccdbMetadataSpec(key, value));
  }
  return result;
}
 
ConfigParamSpec startTimeParamSpec(int64_t t)
{
  return ConfigParamSpec{"start-value-enumeration", VariantType::Int64, t, {fmt::format("start time for enumeration ({})", t)}, ConfigParamKind::kGeneric};
}
 
} // namespace o2::framework