TFileMetadataICARUS.h

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
// Name: TFileMetadataICARUS.h
//
// A struct datatype to hold the metadata information as it is extracted
// from various places.
//
// Created:  30-Dec-2019,  M. Wospakrik
//  based on the SBND version by D. Brailsford which is
//  based on the ProtoDUNE version by T. Junk which is 
//  based on the MicroBooNE version by S. Gollapinni
//
////////////////////////////////////////////////////////////////////////
#ifndef TFILEMETADATAICARUS_H
#define TFILEMETADATAICARUS_H

#include "art/Framework/Services/Registry/ActivityRegistry.h"
#include "art/Framework/Services/Registry/ServiceDeclarationMacros.h"
#include "art/Framework/Principal/fwd.h"
#include "art/Framework/IO/PostCloseFileRenamer.h"
#include "art/Framework/IO/FileStatsCollector.h"
#include "art/Persistency/Provenance/ScheduleContext.h"
#include "canvas/Persistency/Provenance/IDNumber.h"
#include "fhiclcpp/ParameterSet.h"

#include <time.h>
#include <fstream>
#include <set>
#include <string>
#include <tuple>
#include <vector>

namespace icarusutil{

        class TFileMetadataICARUS
        {
                public:
                        TFileMetadataICARUS(fhicl::ParameterSet const& pset, art::ActivityRegistry& reg);

                        struct metadata {
                                std::tuple<std::string, std::string, std::string> fapplication;
                                //no crc information yet
                                //std::vector<std::string> fcrcs;
                                std::string fdata_tier;
                                time_t fend_time;
                                unsigned int fevent_count=0;
                                std::string ffile_format;
                                std::string ffile_type;
                                art::EventNumber_t ffirst_event=0;
                                std::string fgroup; 
                                art::EventNumber_t flast_event=0;
                                std::set<std::string> fParents;
                                std::vector<std::tuple<art::RunNumber_t,art::SubRunNumber_t,std::string>> fruns;
                                time_t fstart_time=0; 
                                std::string fFCLName;
                                std::string fProjectName;
                                std::string fProjectStage;
                                std::string fProjectVersion;
                                std::string fProjectSoftware;
                                std::string fProductionName; //Production parameter, do not use if not running a production
                                std::string fProductionType; //Production parameter, do not use if not running a production
                        };

                        metadata md;
                        std::set<art::SubRunID> fSubRunNumbers;
                        std::map<std::string,std::string> mdmap;    

                private:

                        // Callbacks.
                        void postBeginJob();
                        void postOpenInputFile(std::string const& fn);
                        void postEvent(art::Event const& ev, art::ScheduleContext);
                        void postBeginSubRun(art::SubRun const& subrun);
                        void postCloseInputFile();

                        // Fcl parameters.
                        bool fGenerateTFileMetadata;  
                        std::string fJSONFileName;
                        std::string frunType;
                        art::FileStatsCollector fFileStats;
                        //art::PostCloseFileRenamer fRenamer{fFileStats};
        }; // class TFileMetadataICARUS

} //namespace icarusutils

DECLARE_ART_SERVICE(icarusutil::TFileMetadataICARUS, LEGACY)

#endif