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 = 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 noexcept

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

Detailed Description

Definition at line 21 of file FileCatalogMetadata.h.

Member Typedef Documentation

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

Definition at line 23 of file FileCatalogMetadata.h.

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

Definition at line 63 of file FileCatalogMetadata.h.

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

Definition at line 24 of file FileCatalogMetadata.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 35 of file FileCatalogMetadata.cc.

    : checkSyntax_{config().checkSyntax()}
    , mdToInherit_{maybeTranslate(config().metadataFromInput())}
  {
    if (auto appFam = config().applicationFamily()) {
      addMetadataString("application.family", *appFam);
    }
    if (auto appVer = config().applicationVersion()) {
      addMetadataString("application.version", *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());
    }
    string rt;
    if (!search_translated_all(mdToInherit_, "run_type") &&
        config().runType(rt)) {
      addMetadataString("art.run_type", rt);
    }
    if (auto grp = config().group()) {
      addMetadataString("group", *grp);
    }
    if (auto pid = config().processID()) {
      addMetadataString("process_id", *pid);
    }
  }

Member Function Documentation

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

Definition at line 78 of file FileCatalogMetadata.cc.

  {
    if (checkSyntax_) {
      string checkString("{ ");
      checkString += cet::canonical_string(key) + " : " + value + " }";
      boost::json::error_code ec;
      boost::json::parser p;
      auto const n_parsed_chars = p.write_some(checkString, ec);
      if (ec) {
        throw Exception(errors::DataCorruption)
          << "FileCatalogMetadata::addMetadata() JSON " << ec.message() << ":\n"
          << "Faulty key/value clause:\n"
          << checkString << "\n"
          << (n_parsed_chars ? string(n_parsed_chars, '-') : "") << "^\n";
      }
    }
    std::lock_guard sentry{mutex_};
    md_.emplace_back(key, value);
  }

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

Definition at line 72 of file FileCatalogMetadata.cc.

  {
    addMetadata(key, cet::canonical_string(value));
  }

void art::FileCatalogMetadata::getMetadata

(

collection_type &

coll

)

const

Definition at line 117 of file FileCatalogMetadata.cc.

  {
    std::lock_guard sentry{mutex_};
    cet::copy_all(md_, back_inserter(coll));
  }

void art::FileCatalogMetadata::setMetadataFromInput

(

collection_type const &

coll

)

Definition at line 99 of file FileCatalogMetadata.cc.

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

    std::lock_guard sentry{mutex_};
    if (!imd_) {
      imd_ = make_unique<InheritedMetadata>(mdToInherit_, mdFromInput);
    } else {
      imd_->check_values(mdFromInput);
    }
    for (auto const& [key, value] : imd_->entries()) {
      addMetadataString(oldToNew(key), value);
    }
  }

bool art::FileCatalogMetadata::wantCheckSyntax ( ) const

noexcept

Definition at line 66 of file FileCatalogMetadata.cc.

  {
    return checkSyntax_;
  }

Member Data Documentation

bool const art::FileCatalogMetadata::checkSyntax_

private

Definition at line 136 of file FileCatalogMetadata.h.

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

private

Definition at line 146 of file FileCatalogMetadata.h.

collection_type art::FileCatalogMetadata::md_ {}

private

Definition at line 143 of file FileCatalogMetadata.h.

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

private

Definition at line 140 of file FileCatalogMetadata.h.

std::recursive_mutex art::FileCatalogMetadata::mutex_ {}

mutableprivate

Definition at line 132 of file FileCatalogMetadata.h.

---

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

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