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 ()

Private Member Functions
void	getEnvironment ()
void	initialize_ ()

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 68 of file FileInPath.h.

Member Enumeration Documentation

enum edm::FileInPath::LocationCode

Enumerator
Unknown
Local
Release
Data

Definition at line 72 of file FileInPath.h.

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

Constructor & Destructor Documentation

FileInPath::FileInPath

(

)

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

Definition at line 109 of file FileInPath.cc.

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

explicit

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

Definition at line 117 of file FileInPath.cc.

FileInPath::FileInPath ( const char *  r )

explicit

Definition at line 126 of file FileInPath.cc.

FileInPath::FileInPath

(

FileInPath const &

other

)

Definition at line 138 of file FileInPath.cc.

FileInPath::~FileInPath

(

)

Definition at line 148 of file FileInPath.cc.

Member Function Documentation

std::string 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 184 of file FileInPath.cc.

Referenced by SiStripBadFiberBuilder::algoAnalyze(), SiStripBadChannelBuilder::algoAnalyze(), SiStripNoisesBuilder::analyze(), SiStripApvGainBuilder::analyze(), SiStripPedestalsBuilder::analyze(), SiStripThresholdBuilder::analyze(), MuonGeometrySVGTemplate::analyze(), cms::HcalConstantsASCIIWriter::analyze(), BeamSpotFakeConditions::BeamSpotFakeConditions(), METCorrectorDBWriter::beginJob(), JetCorrectorDBWriter::beginJob(), cms::HcalConstantsASCIIWriter::beginJob(), HcalTPGCoderULUT::buildCoder(), CaloMiscalibTools::CaloMiscalibTools(), CaloMiscalibToolsMC::CaloMiscalibToolsMC(), GBRForestWriter::categoryEntryType::categoryEntryType(), SiStripThresholdGenerator::createObject(), SiStripNoisesGenerator::createObject(), SiStripLatencyGenerator::createObject(), SiStripBaseDelayGenerator::createObject(), SiStripBackPlaneCorrectionGenerator::createObject(), CustomPhysicsList::CustomPhysicsList(), CustomPhysicsListSS::CustomPhysicsListSS(), HcalTPGCoderULUT::dbRecordCallback(), EcalDQMonitorClient::EcalDQMonitorClient(), ElectronIdMVAProducer::ElectronIdMVAProducer(), ElectronPATIdMVAProducer::ElectronPATIdMVAProducer(), ESElectronicsMapper::ESElectronicsMapper(), ESPedestalClient::ESPedestalClient(), MultipleScatteringX0Data::fileName(), CSCReadoutMappingFromFile::fill(), SiStripGain::fillNewGain(), muonisolation::IsolatorByNominalEfficiency::findPath(), gen::BaseHadronizer::generateLHE(), GeometryConfiguration::GeometryConfiguration(), getfullpathfromfip_(), SiStripGainFromAsciiFile::getNewObject(), SiStripBadStripFromASCIIFile::getNewObject(), EcalMappingElectronicsHandler::getNewObjects(), pfEGHelpers::HeavyObjectCache::HeavyObjectCache(), PDFWeightsHelper::Init(), CandidateBoostedDoubleSecondaryVertexComputer::initialize(), MuonTagger::initialize(), CombinedMVAV2JetTagComputer::initialize(), ElectronTagger::initialize(), CharmTagger::initialize(), L1GtTriggerMenuXmlProducer::L1GtTriggerMenuXmlProducer(), L1TMuonOverlapParamsESProducer::L1TMuonOverlapParamsESProducer(), L1MuDTPhiLut::load(), L1MuDTEtaPatternLut::load(), L1MuDTQualPatternLut::load(), SiStripHashedDetIdFakeESSource::make(), MultiEventFilter::MultiEventFilter(), PhysicsTools::MVAComputerESSourceBase::MVAComputerESSourceBase(), cond::persistency::parseFipConnectionString(), EcalTrigTowerConstituentsMapBuilder::parseTextMap(), CaloTowerConstituentsMapBuilder::parseTextMap(), SiPixelFakeCPEGenericErrorParmESSource::produce(), SiPixelFakeTemplateDBObjectESSource::produce(), SiPixelFakeGenErrorDBObjectESSource::produce(), HepPDTESSource::produce(), SiPixelFakeGainOfflineESSource::produce(), SiPixelFakeGainESSource::produce(), SiPixelFakeGainForHLTESSource::produce(), SiPixelFakeLorentzAngleESSource::produce(), JetCorrectionESSource< Corrector >::produce(), gen::PtYDistributor::PtYDistributor(), FIPConfiguration::readConfig(), SiStripNoisesDQMService::readNoises(), SiStripPedestalsDQMService::readPedestals(), RPCDBSimSetUp::RPCDBSimSetUp(), ShiftedPFCandidateProducerForNoPileUpPFMEt::ShiftedPFCandidateProducerForNoPileUpPFMEt(), ShiftedPFCandidateProducerForPFNoPUMEt::ShiftedPFCandidateProducerForPFNoPUMEt(), SiStripBadModuleByHandBuilder::SiStripBadModuleByHandBuilder(), SiStripDetInfoFileReader::SiStripDetInfoFileReader(), PhysicsTools::MVATrainerLooper::Trainer::Trainer(), and ZSPJPTJetCorrector::ZSPJPTJetCorrector().

void FileInPath::getEnvironment ( void  )

private

Definition at line 393 of file FileInPath.cc.

void FileInPath::initialize_ ( )

private

Definition at line 427 of file FileInPath.cc.

FileInPath::LocationCode FileInPath::location

(

)

const

Where was the file found?

Definition at line 178 of file FileInPath.cc.

Referenced by edm::operator==(), ShiftedPFCandidateProducerForNoPileUpPFMEt::ShiftedPFCandidateProducerForNoPileUpPFMEt(), and ShiftedPFCandidateProducerForPFNoPUMEt::ShiftedPFCandidateProducerForPFNoPUMEt().

FileInPath & FileInPath::operator=

(

FileInPath const &

other

)

Definition at line 151 of file FileInPath.cc.

void 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 253 of file FileInPath.cc.

Referenced by edm::operator>>().

void FileInPath::readFromParameterSetBlob

(

std::istream &

is

)

Definition at line 332 of file FileInPath.cc.

std::string 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 171 of file FileInPath.cc.

Referenced by PDFWeightsHelper::Init(), and edm::operator==().

void FileInPath::swap

(

FileInPath &

other

)

Definition at line 159 of file FileInPath.cc.

Referenced by edm::swap().

void 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 190 of file FileInPath.cc.

Referenced by edm::operator<<().

Member Data Documentation

std::string edm::FileInPath::canonicalFilename_

private

Definition at line 121 of file FileInPath.h.

std::string edm::FileInPath::dataTop_

private

Definition at line 125 of file FileInPath.h.

std::string edm::FileInPath::localTop_

private

Definition at line 123 of file FileInPath.h.

LocationCode edm::FileInPath::location_

private

Definition at line 122 of file FileInPath.h.

std::string edm::FileInPath::relativePath_

private

Definition at line 120 of file FileInPath.h.

std::string edm::FileInPath::releaseTop_

private

Definition at line 124 of file FileInPath.h.

std::string edm::FileInPath::searchPath_

private

Definition at line 126 of file FileInPath.h.