art::FileCatalogMetadata Class Reference

#include "FileCatalogMetadata.h"

Classes
struct	Config
class	InheritedMetadata

Public Types
using	collection_type = std::vector< std::pair< std::string, std::string >>
using	value_type = typename collection_type::value_type
using	Parameters = ServiceTable< Config >

Public Member Functions
	FileCatalogMetadata (Parameters const &config)
void	addMetadata (std::string const &key, std::string const &value)
void	addMetadataString (std::string const &key, std::string const &value)
void	getMetadata (collection_type &coll) const
void	setMetadataFromInput (collection_type const &coll)
bool	wantCheckSyntax () const

Static Private Member Functions
static std::mutex &	service_mutex ()

Private Attributes
bool const	checkSyntax_
collection_type	md_ {}
std::unique_ptr< InheritedMetadata >	imd_ {}
std::vector< std::string >	mdToInherit_

Detailed Description

Definition at line 39 of file FileCatalogMetadata.h.

Member Typedef Documentation

using art::FileCatalogMetadata::collection_type = std::vector<std::pair<std::string, std::string>>

Definition at line 41 of file FileCatalogMetadata.h.

using art::FileCatalogMetadata::Parameters = ServiceTable<Config>

Definition at line 81 of file FileCatalogMetadata.h.

using art::FileCatalogMetadata::value_type = typename collection_type::value_type

Definition at line 42 of file FileCatalogMetadata.h.

Constructor & Destructor Documentation

art::FileCatalogMetadata::FileCatalogMetadata ( Parameters const &  config )

explicit

Definition at line 25 of file FileCatalogMetadata_service.cc.

References addMetadataString(), IGNORE_FALLTHROUGH_END::maybeTranslate(), mdToInherit_, and IGNORE_FALLTHROUGH_END::search_translated_all().

  : checkSyntax_{config().checkSyntax()}
  , mdToInherit_{maybeTranslate(config().metadataFromInput())}
{
  std::string appFam;
  if (config().applicationFamily(appFam)) {
    addMetadataString("applicationFamily", appFam);
  }

  std::string appVer;
  if (config().applicationVersion(appVer)) {
    addMetadataString("applicationVersion", appVer);
  }

  // Always write out fileType -- either by inheriting from the input
  // file or by overriding via the FHiCL parameter "fileType".
  if (!search_translated_all(mdToInherit_, "file_type")) {
    addMetadataString("file_type", config().fileType());
  }

  std::string rt;
  if (!search_translated_all(mdToInherit_, "run_type") &&
      config().runType(rt)) {
    addMetadataString("run_type", rt);
  }

  std::string g;
  if (config().group(g)) {
    addMetadataString("group", g);
  }

  std::string pid;
  if (config().processID(pid)) {
    addMetadataString("process_id", pid);
  }
}

Member Function Documentation

void art::FileCatalogMetadata::addMetadata	(	std::string const &	key,
		std::string const &	value
	)

Definition at line 64 of file FileCatalogMetadata_service.cc.

References checkSyntax_, d, art::errors::DataCorruption, DEFINE_ART_SERVICE, md_, service_mutex(), and fhicl::detail::atom::value().

Referenced by addMetadataString(), and util::FileCatalogMetadataExtras::postBeginJob().

{
  if (checkSyntax_) {
    // rapidjson claims to be largely re-entrant, according to
    // https://github.com/miloyip/rapidjson/issues/141.  Therefore, we
    // do not worry about locking this part of the function.
    rapidjson::Document d;
    std::string checkString("{ ");
    checkString += cet::canonical_string(key);
    checkString += " : ";
    checkString += value;
    checkString += " }";
    if (d.Parse(checkString.c_str()).HasParseError()) {
      auto const nSpaces = d.GetErrorOffset();
      throw Exception(errors::DataCorruption)
        << "art::FileCatalogMetadata::addMetadata() JSON syntax error:\n"
        << rapidjson::GetParseError_En(d.GetParseError())
        << " Faulty key/value clause:\n"
        << checkString << "\n"
        << (nSpaces ? std::string(nSpaces, '-') : "") << "^\n";
    }
  }
  std::lock_guard<std::mutex> lock{service_mutex()};
  md_.emplace_back(key, value);
}

void art::FileCatalogMetadata::addMetadataString ( std::string const &  key, std::string const &  value  )

inline

Definition at line 165 of file FileCatalogMetadata.h.

References addMetadata().

Referenced by FileCatalogMetadata(), and setMetadataFromInput().

{
  // No lock here -- it is held by addMetadata
  addMetadata(key, cet::canonical_string(value));
}

void art::FileCatalogMetadata::getMetadata ( collection_type &  coll ) const

inline

Definition at line 194 of file FileCatalogMetadata.h.

References DECLARE_ART_SERVICE, art::LEGACY, md_, and service_mutex().

Referenced by util::FileCatalogMetadataExtras::postBeginJob().

{
  std::lock_guard<std::mutex> lock{service_mutex()};
  cet::copy_all(md_, std::back_inserter(coll));
}

static std::mutex& art::FileCatalogMetadata::service_mutex ( )

inlinestaticprivate

Definition at line 157 of file FileCatalogMetadata.h.

Referenced by addMetadata(), and getMetadata().

  {
    static std::mutex m;
    return m;
  };

void art::FileCatalogMetadata::setMetadataFromInput ( collection_type const &  coll )

inline

Definition at line 173 of file FileCatalogMetadata.h.

References addMetadataString(), imd_, and mdToInherit_.

{
  CET_ASSERT_ONLY_ONE_THREAD();
  if (mdToInherit_.empty()) {
    return;
  }

  if (!imd_) {
    imd_ = std::make_unique<InheritedMetadata>(mdToInherit_, mdFromInput);
  } else {
    imd_->check_values(mdFromInput);
  }

  OldToNew const translator;
  for (auto const& pr : imd_->entries()) {
    addMetadataString(translator(pr.first), pr.second);
  }
}

bool art::FileCatalogMetadata::wantCheckSyntax ( ) const

inline

Definition at line 97 of file FileCatalogMetadata.h.

References checkSyntax_.

  {
    return checkSyntax_;
  }

Member Data Documentation

bool const art::FileCatalogMetadata::checkSyntax_

private

Definition at line 103 of file FileCatalogMetadata.h.

Referenced by addMetadata(), and wantCheckSyntax().

std::unique_ptr<InheritedMetadata> art::FileCatalogMetadata::imd_ {}

private

Definition at line 150 of file FileCatalogMetadata.h.

Referenced by setMetadataFromInput().

collection_type art::FileCatalogMetadata::md_ {}

private

Definition at line 104 of file FileCatalogMetadata.h.

Referenced by addMetadata(), and getMetadata().

std::vector<std::string> art::FileCatalogMetadata::mdToInherit_

private

Definition at line 151 of file FileCatalogMetadata.h.

Referenced by FileCatalogMetadata(), and setMetadataFromInput().

---

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

• art/Framework/Services/System/FileCatalogMetadata.h
• art/Framework/Services/System/FileCatalogMetadata_service.cc