edm::FileInPath Class Reference

#include <FileInPath.h>

Public Types
enum	LocationCode { Unknown = 0, Local = 1, Release = 2, Data = 3 }

Public Member Functions
	FileInPath ()
	FileInPath (const std::string &r)
	We throw an exception is the referenced file is not found. More...
	FileInPath (const char *r)
	FileInPath (FileInPath const &other)
std::string	fullPath () const
LocationCode	location () const
	Where was the file found? More...
FileInPath &	operator= (FileInPath const &other)
void	read (std::istream &is)
void	readFromParameterSetBlob (std::istream &is)
std::string	relativePath () const
void	swap (FileInPath &other)
void	write (std::ostream &os) const
	~FileInPath ()

Static Public Member Functions
static void	disableFileLookup ()
	Should only be called while the edmWriteConfigs executable runs. More...
static std::string	findFile (std::string const &)

Private Member Functions
void	getEnvironment ()
void	initialize_ ()

Static Private Member Functions
static std::string const &	searchPath ()

Private Attributes
std::string	canonicalFilename_
std::string	dataTop_
std::string	localTop_
LocationCode	location_
std::string	relativePath_
std::string	releaseTop_
std::string	searchPath_

Detailed Description

Definition at line 61 of file FileInPath.h.

Member Enumeration Documentation

LocationCode

enum edm::FileInPath::LocationCode

Enumerator
Unknown
Local
Release
Data

Definition at line 63 of file FileInPath.h.

{ Unknown = 0, Local = 1, Release = 2, Data = 3 };

Constructor & Destructor Documentation

FileInPath() [1/4]

edm::FileInPath::FileInPath

(

)

Default c'tor does no file-existence check; what file would it check for existence?

Definition at line 104 of file FileInPath.cc.

References getEnvironment().

                         : relativePath_(), canonicalFilename_(), location_(Unknown) {
    if (s_fileLookupDisabled) {
      return;
    }
    getEnvironment();
  }

FileInPath() [2/4]

edm::FileInPath::FileInPath ( const std::string &  r )

explicit

We throw an exception is the referenced file is not found.

Definition at line 111 of file FileInPath.cc.

References getEnvironment(), and initialize_().

                                           : relativePath_(r), canonicalFilename_(), location_(Unknown) {
    if (s_fileLookupDisabled) {
      return;
    }
    getEnvironment();
    initialize_();
  }

FileInPath() [3/4]

edm::FileInPath::FileInPath ( const char *  r )

explicit

Definition at line 119 of file FileInPath.cc.

References Exception, edm::errors::FileInPathError, getEnvironment(), and initialize_().

                                      : relativePath_(r ? r : ""), canonicalFilename_(), location_(Unknown) {
    if (s_fileLookupDisabled) {
      return;
    }
    if (r == nullptr) {
      throw edm::Exception(edm::errors::FileInPathError) << "Relative path must not be null\n";
    }
    getEnvironment();
    initialize_();
  }

FileInPath() [4/4]

edm::FileInPath::FileInPath

(

FileInPath const &

other

)

Definition at line 130 of file FileInPath.cc.

      : relativePath_(other.relativePath_),
        canonicalFilename_(other.canonicalFilename_),
        location_(other.location_),
        localTop_(other.localTop_),
        releaseTop_(other.releaseTop_),
        dataTop_(other.dataTop_),
        searchPath_(other.searchPath_) {}

~FileInPath()

edm::FileInPath::~FileInPath

(

)

Definition at line 139 of file FileInPath.cc.

{}

Member Function Documentation

disableFileLookup()

void edm::FileInPath::disableFileLookup ( )

static

Should only be called while the edmWriteConfigs executable runs.

Definition at line 450 of file FileInPath.cc.

{ s_fileLookupDisabled = true; }

findFile()

std::string edm::FileInPath::findFile ( std::string const &  iFileName )

static

Uses the same algorithm to find the file but does not determine the location. Returns an empty string if unfound.

Definition at line 452 of file FileInPath.cc.

References castor_dqm_sourceclient_file_cfg::path, searchPath(), and edm::tokenize().

Referenced by magneticfield::InterpolatorBuilder::build(), and magneticfield::InterpolatorBuilder::InterpolatorBuilder().

                                                           {
    // Find the file, based on the value of path variable.
    auto pathElements = tokenize(searchPath(), ":");
    for (auto const& element : pathElements) {
      // Set the boost::fs path to the current element of
      // CMSSW_SEARCH_PATH:
      std::filesystem::path pathPrefix(element);

      // Does the a file exist? locateFile throws is it finds
      // something goofy.
      if (locateFile(pathPrefix, iFileName)) {
        // Convert relative path to canonical form, and save it.
        return std::filesystem::absolute(pathPrefix / iFileName).string();
      }
    }
    return {};
  }

fullPath()

std::string edm::FileInPath::fullPath

(

)

const

Return a string that can be used to open the referenced file.

Note that operations on this file may fail, including testing for existence. This is because the state of a filesystem is global; other threads, processes, etc., may have removed the file since we checked on its existence at the time of construction of the FileInPath object.

Definition at line 161 of file FileInPath.cc.

References canonicalFilename_.

Referenced by Phase1PixelSummaryMap::addNamedBins(), MillePedeAlignmentAlgorithm::addPxbSurvey(), SiStripPedestalsBuilder::analyze(), SiStripThresholdBuilder::analyze(), SiStripApvGainBuilder::analyze(), SiStripNoisesBuilder::analyze(), SiStripNoisesAndBadCompsChecker::analyze(), JetCorrectorDemo::analyze(), MuonGeometrySVGTemplate::analyze(), HcalLutAnalyzer::analyze(), HGCalWaferValidation::analyze(), PixelRegions::attachedDets(), BeamSpotFakeConditions::BeamSpotFakeConditions(), JetCorrectorDBWriter::beginJob(), ProtonTaggerFilter::beginJob(), OMTFReconstruction::beginRun(), omtf::OmtfPacker::beginRun(), omtf::OmtfUnpacker::beginRun(), GoodSeedProducer::beginRun(), ExternalLHEProducer::beginRunProduce(), HGCalValidator::bookHistograms(), SiStripQualityHotStripIdentifier::bookHistos(), BTagSFProducer::BTagSFProducer(), HcalTPGCoderULUT::buildCoder(), MagGeoBuilderFromDDD::buildInterpolator(), CacheData::CacheData(), CaloMiscalibTools::CaloMiscalibTools(), CaloMiscalibToolsMC::CaloMiscalibToolsMC(), GBRForestWriter::categoryEntryType::categoryEntryType(), CTPPSPixelDAQMappingESSourceXML::CompleteFileName(), TotemDAQMappingESSourceXML::CompleteFileName(), createGBRForest(), CSCTFPtLUT::CSCTFPtLUT(), SiStripPopConNoisesHandlerFromDQM::dqmEndJob(), SiStripPopConPedestalsHandlerFromDQM::dqmEndJob(), SiStripPopConBadComponentsHandlerFromDQM::dqmEndJob(), DTOccupancyTestML::dqmEndLuminosityBlock(), dtCalibration::DTTTrigResidualCorrection::DTTTrigResidualCorrection(), EcalEBPhase2TPParamProducer::EcalEBPhase2TPParamProducer(), ElectronPATIdMVAProducer::ElectronPATIdMVAProducer(), OccupancyPlots::endRun(), ESDataFormatterV4::ESDataFormatterV4(), ESDigiToRaw::ESDigiToRaw(), ESElectronicsMapper::ESElectronicsMapper(), ESIntegrityClient::ESIntegrityClient(), ESPedestalClient::ESPedestalClient(), ESUnpacker::ESUnpacker(), LateralityCoarsedProvider::fill_lat_combinations(), MuonPathSLFitter::fillLuts(), MuonPathCorFitter::fillLuts(), HGCalTriggerGeometryV9Imp2::fillMaps(), HGCalTriggerGeometryV9Imp3::fillMaps(), edm::service::FixMissingStreamerInfos::FixMissingStreamerInfos(), ESTrivialConditionRetriever::getChannelStatusFromConfiguration(), EcalTrivialConditionRetriever::getChannelStatusFromConfiguration(), EcalTrivialConditionRetriever::getMappingFromConfiguration(), SiStripGainFromAsciiFile::getNewObject(), SiStripBadModuleByHandBuilder::getNewObject(), SiStripBadChannelBuilder::getNewObject(), SiStripBadStripFromASCIIFile::getNewObject(), SiStripNoisesFromDBMiscalibrator::getNewObject_withDefaults(), EcalMappingElectronicsHandler::getNewObjects(), EcalTrivialConditionRetriever::getPFRecHitThresholdsFromConfiguration(), EcalTrivialConditionRetriever::getTrgChannelStatusFromConfiguration(), ESTrivialConditionRetriever::getWeightsFromConfiguration(), EcalTrivialConditionRetriever::getWeightsFromConfiguration(), HcalHardcodeCalibrations::HcalHardcodeCalibrations(), HcalLaserEventFilter2012::HcalLaserEventFilter2012(), l1t::HGC3DClusterTMVASelector::HGC3DClusterTMVASelector(), HGCalMappingESProducer::HGCalMappingESProducer(), HGCalNumberingScheme::HGCalNumberingScheme(), HGCalTriggerTowerGeometryHelper::HGCalTriggerTowerGeometryHelper(), HGCalValidator::HGCalValidator(), HGCScintSD::HGCScintSD(), PDFWeightsHelper::Init(), gen::EvtGenInterface::init(), l1tpf::corrector::init_(), CandidateBoostedDoubleSecondaryVertexComputer::initialize(), MuonTagger::initialize(), CandidateChargeBTagComputer::initialize(), CombinedMVAV2JetTagComputer::initialize(), ElectronTagger::initialize(), CharmTagger::initialize(), HeavyIonCSVTagger::initialize(), ApeSettingAlgorithm::initialize(), TritonEDFilterT< G, Capabilities >::initializeGlobalCache(), TritonEDProducerT< G, Capabilities >::initializeGlobalCache(), DeepMETProducer::initializeGlobalCache(), L1NNTauProducer::initializeGlobalCache(), TracksterLinksProducer::initializeGlobalCache(), L1NNCaloTauProducer::initializeGlobalCache(), L1NNCaloTauEmulator::initializeGlobalCache(), DeepTauId::initializeGlobalCache(), L2TauNNProducerAlpaka::initializeGlobalCache(), L2TauNNProducer::initializeGlobalCache(), PileupJetIdProducer::initJetEnergyCorrector(), egammaTools::EgammaDNNHelper::initScalerFiles(), reco::DeepSCGraphEvaluation::initTensorFlowGraphAndSession(), L1FPGATrackProducer::L1FPGATrackProducer(), L1TGlobalPrescalesVetosESProducer::L1TGlobalPrescalesVetosESProducer(), L1TGlobalPrescalesVetosFractESProducer::L1TGlobalPrescalesVetosFractESProducer(), L1TMuonOverlapParamsESProducer::L1TMuonOverlapParamsESProducer(), L1TrackVertexAssociationProducer::L1TrackVertexAssociationProducer(), CovarianceParameterization::load(), L1MuDTPtaLut::load(), L1MuDTPhiLut::load(), L1MuDTEtaPatternLut::load(), L1MuBMTEtaPatternLut::load(), L1MuDTQualPatternLut::load(), L1MuBMTQualPatternLut::load(), L1MuDTExtLut::load(), L1TMuonBarrelParamsHelper::load_ext(), L1TMuonBarrelParamsHelper::load_phi(), L1TMuonBarrelParamsHelper::load_pt(), DTCCablingMapProducer::LoadModulesToDTCCablingMapFromCSV(), ClusterShapeHitFilter::loadStripLimits(), SiStripFedCablingFakeESSource::make(), jpt::Map::Map(), MaterialBudgetCategorizer::MaterialBudgetCategorizer(), MPFilter::MPFilter(), MuonHLTSeedMVAClassifier::MuonHLTSeedMVAClassifier(), pat::MuonMvaIDEstimator::MuonMvaIDEstimator(), MuonPathAnalyticAnalyzer::MuonPathAnalyticAnalyzer(), MuonPathAnalyzerInChamber::MuonPathAnalyzerInChamber(), MuonPathAssociator::MuonPathAssociator(), MuonPathConfirmator::MuonPathConfirmator(), MuonPathFitter::MuonPathFitter(), MuonPathSLFitter::MuonPathSLFitter(), MVAJetPuId::MVAJetPuId(), MVAVariableManager< reco::GsfElectron >::MVAVariableManager(), fastsim::NuclearInteraction::NuclearInteraction(), NuclearInteractionSimulator::NuclearInteractionSimulator(), OnlineDQMDigiAD::OnlineDQMDigiAD(), OverlapValidation::OverlapValidation(), HcalTBObjectUnpacker::parseCalib(), cond::persistency::parseFipConnectionString(), EcalEBTrigPrimPhase2ESProducer::parseTextFile(), EcalTrigPrimESProducer::parseTextFile(), EcalTrigTowerConstituentsMapBuilder::parseTextMap(), CaloTowerConstituentsMapBuilder::parseTextMap(), EcalEBTrigPrimPhase2ESProducer::parseWeightsFile(), cms::PileupJPTJetIdAlgo::PileupJPTJetIdAlgo(), PixelTemplateSmearerBase::PixelTemplateSmearerBase(), l1tpf::HGC3DClusterEgID::prepareTMVA(), LwtnnESProducer::produce(), SiPixelFakeLorentzAngleESSource::produce(), HepPDTESSource::produce(), SiPixelFakeGainOfflineESSource::produce(), SiPixelFakeGainESSource::produce(), SiPixelFakeGainForHLTESSource::produce(), ALPAKA_ACCELERATOR_NAMESPACE::hgcal::HGCalMappingModuleESProducer::produce(), HcalTPGCoderULUT::produce(), ALPAKA_ACCELERATOR_NAMESPACE::hgcal::HGCalMappingCellESProducer::produce(), CaloTPGTranscoderULUTs::produce(), MaskedRctInputDigiProducer::produce(), ecaldqm::MLClient::producePlots(), gen::PtYDistributor::PtYDistributor(), gen::Py8HMC3InterfaceBase::Py8HMC3InterfaceBase(), gen::Py8InterfaceBase::Py8InterfaceBase(), PYBIND11_MODULE(), QualityTester::QualityTester(), SiStripApvGainFromFileBuilder::read_tickmark(), reco::DeepSCGraphEvaluation::readInputFeaturesConfig(), CSCTFPtLUT::readLUT(), CSCSectorReceiverLUT::readLUTsFromFile(), GsfBetheHeitlerUpdator::readParameters(), gen::ReggeGribovPartonMCHadronizer::ReggeGribovPartonMCHadronizer(), RPCCalibSetUp::RPCCalibSetUp(), RPCDBSimSetUp::RPCDBSimSetUp(), L1TrackQuality::runEmulatedTQ(), SelectedElectronFEDListProducer< TEle, TCand >::SelectedElectronFEDListProducer(), L1TrackQuality::setL1TrackQuality(), ecaldqm::LedClient::setParams(), ShiftedJetProducerT< T, Textractor >::ShiftedJetProducerT(), ShiftedPFCandidateProducerForNoPileUpPFMEt::ShiftedPFCandidateProducerForNoPileUpPFMEt(), ShiftedPFCandidateProducerForPFNoPUMEt::ShiftedPFCandidateProducerForPFNoPUMEt(), SiLinearChargeDivider::SiLinearChargeDivider(), SiStripApvGainFakeESSource::SiStripApvGainFakeESSource(), SiStripBadModuleConfigurableFakeESSource::SiStripBadModuleConfigurableFakeESSource(), SiStripBaseDelayFakeESSource::SiStripBaseDelayFakeESSource(), SiStripClusters2ApproxClusters::SiStripClusters2ApproxClusters(), SiStripDigitizerAlgorithm::SiStripDigitizerAlgorithm(), SiStripFedCablingFakeESSource::SiStripFedCablingFakeESSource(), SiStripHitEffFromCalibTree::SiStripHitEffFromCalibTree(), SiStripHitResolFromCalibTree::SiStripHitResolFromCalibTree(), SiStripLatencyFakeESSource::SiStripLatencyFakeESSource(), SiStripNoisesFakeESSource::SiStripNoisesFakeESSource(), SiStripPedestalsFakeESSource::SiStripPedestalsFakeESSource(), SiStripThresholdFakeESSource::SiStripThresholdFakeESSource(), trends(), TritonClient::TritonClient(), TtSemiLepHitFitProducer< LeptonCollection >::TtSemiLepHitFitProducer(), emtf::phase2::EMTFContext::update(), l1tVertexFinder::AlgoSettings::vx_pattrec_graph(), l1tVertexFinder::AlgoSettings::vx_trkw_graph(), and FWRecoGeometryESProducer::writeTrackerParametersXML().

{ return canonicalFilename_; }

getEnvironment()

void edm::FileInPath::getEnvironment ( void  )

private

Definition at line 346 of file FileInPath.cc.

References dataTop_, Exception, edm::errors::FileInPathError, localTop_, releaseTop_, searchPath(), searchPath_, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by FileInPath().

                                  {
    searchPath_ = searchPath();
    if (searchPath_.empty()) {
      throw edm::Exception(edm::errors::FileInPathError) << PathVariableName << " must be defined\n";
    }

    static std::string const releaseTop = removeSymLinksSrc(RELEASETOP);
    releaseTop_ = releaseTop;

    static std::string const localTop = removeSymLinksSrc(LOCALTOP);
    localTop_ = localTop;

    static std::string const dataTop = removeSymLinks(DATATOP);
    dataTop_ = dataTop;

    if (releaseTop_.empty()) {
      // RELEASETOP was not set.  This means that the environment is set
      // for the base release itself.  So LOCALTOP actually contains the
      // location of the base release.
      releaseTop_ = localTop_;
      localTop_.clear();
    }
    if (releaseTop_ == localTop_) {
      // RELEASETOP is the same as LOCALTOP.  This means that the environment is set
      // for the base release itself.  So LOCALTOP actually contains the
      // location of the base release.
      localTop_.clear();
    }
  }

initialize_()

void edm::FileInPath::initialize_ ( )

private

Definition at line 376 of file FileInPath.cc.

References beamvalidation::br, canonicalFilename_, Data, dataTop_, Exception, edm::errors::FileInPathError, Local, localTop_, location_, castor_dqm_sourceclient_file_cfg::path, relativePath_, Release, releaseTop_, searchPath_, and edm::tokenize().

Referenced by FileInPath().

                               {
    if (relativePath_.empty()) {
      throw edm::Exception(edm::errors::FileInPathError) << "Relative path must not be empty\n";
    }

    // Find the file, based on the value of searchPath.
    typedef std::vector<std::string> stringvec_t;
    stringvec_t pathElements = tokenize(searchPath_, ":");
    for (auto const& element : pathElements) {
      // Set the path to the current element of CMSSW_SEARCH_PATH:
      std::filesystem::path pathPrefix(element);

      // Does the a file exist? locateFile throws is it finds
      // something goofy.
      if (locateFile(pathPrefix, relativePath_)) {
        // Convert relative path to canonical form, and save it.
        relativePath_ = std::filesystem::path(relativePath_).lexically_normal().string();
        //std::filesystem::path(relativePath_).normalize().string();

        // Save the absolute path.
        canonicalFilename_ = std::filesystem::absolute(pathPrefix / relativePath_).string();
        if (canonicalFilename_.empty()) {
          throw edm::Exception(edm::errors::FileInPathError)
              << "fullPath is empty"
              << "\nrelativePath() is: " << relativePath_ << "\npath prefix is: " << pathPrefix.string() << '\n';
        }

        // From the current path element, find the branch path (basically the path minus the
        // last directory, e.g. /src or /share):
        for (std::filesystem::path br = pathPrefix.parent_path();
             !std::filesystem::weakly_canonical(br).string().empty();
             br = br.parent_path()) {
          if (!localTop_.empty()) {
            // Create a path object for our local path LOCALTOP:
            std::filesystem::path local_(localTop_);
            // If the branch path matches the local path, the file was found locally:
            if (br == local_) {
              location_ = Local;
              return;
            }
          }

          if (!releaseTop_.empty()) {
            // Create a path object for our release path RELEASETOP:
            std::filesystem::path release_(releaseTop_);
            // If the branch path matches the release path, the file was found in the release:
            if (br == release_) {
              location_ = Release;
              return;
            }
          }

          if (!dataTop_.empty()) {
            // Create a path object for our data path DATATOP:
            std::filesystem::path data_(dataTop_);
            // If the branch path matches the data path, the file was found in the data area:
            if (br == data_) {
              location_ = Data;
              return;
            }
          }
        }
      }
    }

    // If we got here, we ran out of path elements without finding
    // what we're looking found.
    throw edm::Exception(edm::errors::FileInPathError)
        << "edm::FileInPath unable to find file " << relativePath_ << " anywhere in the search path."
        << "\nThe search path is defined by: " << PathVariableName << "\n${" << PathVariableName
        << "} is: " << std::getenv(PathVariableName.c_str())
        << "\nCurrent directory is: " << std::filesystem::current_path().string() << "\n";
  }

location()

FileInPath::LocationCode edm::FileInPath::location

(

)

const

Where was the file found?

Definition at line 159 of file FileInPath.cc.

References location_.

Referenced by ShiftedJetProducerT< T, Textractor >::ShiftedJetProducerT(), ShiftedPFCandidateProducerForNoPileUpPFMEt::ShiftedPFCandidateProducerForNoPileUpPFMEt(), and ShiftedPFCandidateProducerForPFNoPUMEt::ShiftedPFCandidateProducerForPFNoPUMEt().

{ return location_; }

operator=()

FileInPath & edm::FileInPath::operator=

(

FileInPath const &

other

)

Definition at line 141 of file FileInPath.cc.

References trackingPlots::other, swap(), and groupFilesInBlocks::temp.

                                                           {
    FileInPath temp(other);
    this->swap(temp);
    return *this;
  }

read()

void edm::FileInPath::read

(

std::istream &

is

)

Read from the given istream, and set contents accordingly. Reading errors are reflected in the state of the stream.

Definition at line 206 of file FileInPath.cc.

References canonicalFilename_, Data, dataTop_, Exception, edm::errors::FileInPathError, DTRecHitClients_cfi::local, Local, localTop_, location_, relativePath_, Release, releaseTop_, AlCaHLTBitMon_QueryRunRegistry::string, Unknown, and BeamSplash_cfg::version.

Referenced by edmIntegrityCheck.PublishToFileSystem::get(), and edm::operator>>().

                                      {
    std::string vsn;
    std::string relname;
    std::string canFilename;
#if 1
    // This #if needed for backward compatibility
    // for files written before CMSSW_1_5_0_pre3.
    is >> vsn;
    if (!is)
      return;
    bool oldFormat = (version != vsn);
    if (oldFormat) {
      relname = vsn;
      bool local;
      is >> local;
      location_ = (local ? Local : Release);
      is >> canFilename;
    } else {
      // Current format
      int loc;
      is >> relname >> loc;
      location_ = static_cast<FileInPath::LocationCode>(loc);
      if (location_ != Unknown) {
        is >> canFilename;
      } else if (relname == "@") {
        relname = "";
      }
    }
#else
    is >> vsn >> relname >> loc >> canFilename;
#endif
    if (!is)
      return;
    relativePath_ = relname;
    if (location_ == Local) {
      if (localTop_.empty()) {
        throw edm::Exception(edm::errors::FileInPathError) << "Environment Variable " << LOCALTOP << " is not set.\n"
                                                           << "Trying to read Local file: " << canFilename << ".\n";
      }
#if 1
      // This #if needed for backward compatibility
      // for files written before CMSSW_1_5_0_pre3.
      if (oldFormat) {
        canonicalFilename_ = canFilename;
      } else
#endif
        canonicalFilename_ = localTop_ + canFilename;
    } else if (location_ == Release) {
      if (releaseTop_.empty()) {
        throw edm::Exception(edm::errors::FileInPathError) << "Environment Variable " << RELEASETOP << " is not set.\n";
      }
#if 1
      // This #if needed for backward compatibility
      // for files written before CMSSW_1_5_0_pre3.
      if (oldFormat) {
        std::string::size_type pos = canFilename.find(BASE);
        if (pos == 0) {
          // Replace the placehoder with the path to the base release (site dependent).
          canonicalFilename_ = releaseTop_ + canFilename.substr(BASE.size());
        } else {
          // Needed for files written before CMSSW_1_2_0_pre2.
          canonicalFilename_ = canFilename;
        }
      } else
#endif
        canonicalFilename_ = releaseTop_ + canFilename;
    } else if (location_ == Data) {
      if (dataTop_.empty()) {
        throw edm::Exception(edm::errors::FileInPathError) << "Environment Variable " << DATATOP << " is not set.\n";
      }
      canonicalFilename_ = dataTop_ + canFilename;
    }
  }

readFromParameterSetBlob()

void edm::FileInPath::readFromParameterSetBlob

(

std::istream &

is

)

Definition at line 280 of file FileInPath.cc.

References canonicalFilename_, Data, dataTop_, Exception, edm::errors::FileInPathError, DTRecHitClients_cfi::local, Local, localTop_, location_, relativePath_, Release, releaseTop_, AlCaHLTBitMon_QueryRunRegistry::string, Unknown, and BeamSplash_cfg::version.

                                                          {
    std::string vsn;
    std::string relname;
    std::string canFilename;
    is >> vsn;
    if (!is)
      return;
    bool oldFormat = (version != vsn);
    if (oldFormat) {
      relname = vsn;
      bool local;
      is >> local;
      location_ = (local ? Local : Release);
      is >> canFilename;
    } else {
      // Current format
      int loc;
      is >> relname >> loc;
      location_ = static_cast<FileInPath::LocationCode>(loc);
      if (location_ != Unknown) {
        is >> canFilename;
      } else if (relname == "@") {
        relname = "";
      }
    }
    if (!is)
      return;
    relativePath_ = relname;
    if (location_ == Local) {
      if (localTop_.empty()) {
        localTop_ = "@LOCAL";
      }
      if (oldFormat) {
        canonicalFilename_ = canFilename;
      } else
        canonicalFilename_ = localTop_ + canFilename;
    } else if (location_ == Release) {
      if (releaseTop_.empty()) {
        releaseTop_ = "@RELEASE";
      }
      if (oldFormat) {
        std::string::size_type pos = canFilename.find(BASE);
        if (pos == 0) {
          // Replace the placehoder with the path to the base release (site dependent).
          canonicalFilename_ = releaseTop_ + canFilename.substr(BASE.size());
        } else {
          // Needed for files written before CMSSW_1_2_0_pre2.
          canonicalFilename_ = canFilename;
        }
      } else
        canonicalFilename_ = releaseTop_ + canFilename;
    } else if (location_ == Data) {
      if (dataTop_.empty()) {
        throw edm::Exception(edm::errors::FileInPathError) << "Environment Variable " << DATATOP << " is not set.\n";
      }
      canonicalFilename_ = dataTop_ + canFilename;
    }
  }

relativePath()

std::string edm::FileInPath::relativePath

(

)

const

Return a string containing the canonical form of the relative path. DO NOT USE THIS AS THE FILENAME for any file operations; use fullPath() for that purpose.

Definition at line 157 of file FileInPath.cc.

References relativePath_.

Referenced by PDFWeightsHelper::Init(), and PYBIND11_MODULE().

{ return relativePath_; }

searchPath()

std::string const & edm::FileInPath::searchPath ( )

staticprivate

Definition at line 340 of file FileInPath.cc.

References AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by findFile(), and getEnvironment().

                                          {
    static std::string const s_searchPath = removeSymLinksTokens(PathVariableName);
    return s_searchPath;
  }

swap()

void edm::FileInPath::swap

(

FileInPath &

other

)

Definition at line 147 of file FileInPath.cc.

References canonicalFilename_, dataTop_, localTop_, location_, trackingPlots::other, relativePath_, releaseTop_, searchPath_, and edm::swap().

Referenced by operator=().

                                         {
    relativePath_.swap(other.relativePath_);
    canonicalFilename_.swap(other.canonicalFilename_);
    std::swap(location_, other.location_);
    localTop_.swap(other.localTop_);
    releaseTop_.swap(other.releaseTop_);
    dataTop_.swap(other.dataTop_);
    searchPath_.swap(other.searchPath_);
  }

write()

void edm::FileInPath::write

(

std::ostream &

os

)

const

Write contents to the given ostream. Writing errors are reflected in the state of the stream.

Definition at line 163 of file FileInPath.cc.

References canonicalFilename_, Data, dataTop_, Exception, edm::errors::FileInPathError, Local, localTop_, location_, l1tGTMenu_BTagSeeds_cff::os, relativePath_, Release, releaseTop_, Unknown, and BeamSplash_cfg::version.

Referenced by edm::operator<<().

                                             {
    if (location_ == Unknown) {
      if (relativePath_.empty()) {
        os << version << " @ " << location_;
      } else {
        os << version << ' ' << relativePath_ << ' ' << location_;
      }
    } else if (location_ == Local) {
      // Guarantee a site independent value by stripping $LOCALTOP.
      if (localTop_.empty()) {
        throw edm::Exception(edm::errors::FileInPathError) << "Environment Variable " << LOCALTOP << " is not set.\n";
      }
      std::string::size_type pos = canonicalFilename_.find(localTop_);
      if (pos != 0) {
        throw edm::Exception(edm::errors::FileInPathError)
            << "Path " << canonicalFilename_ << " is not in the local release area " << localTop_ << "\n";
      }
      os << version << ' ' << relativePath_ << ' ' << location_ << ' ' << canonicalFilename_.substr(localTop_.size());
    } else if (location_ == Release) {
      // Guarantee a site independent value by stripping $RELEASETOP.
      if (releaseTop_.empty()) {
        throw edm::Exception(edm::errors::FileInPathError) << "Environment Variable " << RELEASETOP << " is not set.\n";
      }
      std::string::size_type pos = canonicalFilename_.find(releaseTop_);
      if (pos != 0) {
        throw edm::Exception(edm::errors::FileInPathError)
            << "Path " << canonicalFilename_ << " is not in the base release area " << releaseTop_ << "\n";
      }
      os << version << ' ' << relativePath_ << ' ' << location_ << ' ' << canonicalFilename_.substr(releaseTop_.size());
    } else if (location_ == Data) {
      // Guarantee a site independent value by stripping $DATATOP.
      if (dataTop_.empty()) {
        throw edm::Exception(edm::errors::FileInPathError) << "Environment Variable " << DATATOP << " is not set.\n";
      }
      std::string::size_type pos = canonicalFilename_.find(dataTop_);
      if (pos != 0) {
        throw edm::Exception(edm::errors::FileInPathError)
            << "Path " << canonicalFilename_ << " is not in the data area " << dataTop_ << "\n";
      }
      os << version << ' ' << relativePath_ << ' ' << location_ << ' ' << canonicalFilename_.substr(dataTop_.size());
    }
  }

Member Data Documentation

canonicalFilename_

std::string edm::FileInPath::canonicalFilename_

private

Definition at line 116 of file FileInPath.h.

Referenced by fullPath(), initialize_(), read(), readFromParameterSetBlob(), swap(), and write().

dataTop_

std::string edm::FileInPath::dataTop_

private

Definition at line 120 of file FileInPath.h.

Referenced by getEnvironment(), initialize_(), read(), readFromParameterSetBlob(), swap(), and write().

localTop_

std::string edm::FileInPath::localTop_

private

Definition at line 118 of file FileInPath.h.

Referenced by getEnvironment(), initialize_(), read(), readFromParameterSetBlob(), swap(), and write().

location_

LocationCode edm::FileInPath::location_

private

Definition at line 117 of file FileInPath.h.

Referenced by initialize_(), location(), read(), readFromParameterSetBlob(), swap(), and write().

relativePath_

std::string edm::FileInPath::relativePath_

private

Definition at line 115 of file FileInPath.h.

Referenced by initialize_(), read(), readFromParameterSetBlob(), relativePath(), swap(), and write().

releaseTop_

std::string edm::FileInPath::releaseTop_

private

Definition at line 119 of file FileInPath.h.

Referenced by getEnvironment(), initialize_(), read(), readFromParameterSetBlob(), swap(), and write().

searchPath_

std::string edm::FileInPath::searchPath_

private

Definition at line 121 of file FileInPath.h.

Referenced by getEnvironment(), initialize_(), and swap().