cms::Exception Class Reference

#include <Exception.h>

Inheritance diagram for cms::Exception:

Public Member Functions
void	addAdditionalInfo (std::string const &info)
void	addAdditionalInfo (char const *info)
void	addContext (std::string const &context)
void	addContext (char const *context)
std::list< std::string > const &	additionalInfo () const
bool	alreadyPrinted () const
void	append (Exception const &another)
void	append (std::string const &more_information)
void	append (char const *more_information)
std::string const &	category () const
void	clearAdditionalInfo ()
void	clearContext ()
void	clearMessage ()
virtual Exception *	clone () const
std::list< std::string > const &	context () const
	Exception (std::string const &aCategory)
	Exception (char const *aCategory)
	Exception (std::string const &aCategory, std::string const &message)
	Exception (char const *aCategory, std::string const &message)
	Exception (std::string const &aCategory, char const *message)
	Exception (char const *aCategory, char const *message)
	Exception (std::string const &aCategory, std::string const &message, Exception const &another)
	Exception (Exception const &other)
virtual std::string	explainSelf () const
std::list< std::string >	history () const
std::string	message () const
Exception &	operator= (Exception const &other)
void	raise ()
int	returnCode () const
void	setAdditionalInfo (std::list< std::string > const &info)
void	setAlreadyPrinted ()
void	setContext (std::list< std::string > const &context)
void	swap (Exception &other)
char const *	what () const noexcept override
	~Exception () noexcept override

Private Member Functions
void	init (std::string const &message)
virtual void	rethrow ()
virtual int	returnCode_ () const

Private Attributes
std::list< std::string >	additionalInfo_
std::atomic< bool >	alreadyPrinted_
std::string	category_
std::list< std::string >	context_
std::ostringstream	ost_
std::string	what_

Friends
template<typename E , typename T >
detail::exception_type< E > &	operator<< (E &&e, T const &stuff)
template<typename E >
detail::exception_type< E > &	operator<< (E &&e, std::ostream &(*f)(std::ostream &))
template<typename E >
detail::exception_type< E > &	operator<< (E &&e, std::ios_base &(*f)(std::ios_base &))

Detailed Description

Definition at line 59 of file Exception.h.

Constructor & Destructor Documentation

Exception() [1/8]

Exception::Exception ( std::string const &  aCategory )

explicit

Definition at line 6 of file Exception.cc.

Referenced by clone().

      : std::exception(), ost_(), category_(aCategory), what_(), context_(), additionalInfo_(), alreadyPrinted_(false) {}

Exception() [2/8]

Exception::Exception ( char const *  aCategory )

explicit

Definition at line 9 of file Exception.cc.

      : std::exception(),
        ost_(),
        category_(std::string(aCategory)),
        what_(),
        context_(),
        additionalInfo_(),
        alreadyPrinted_(false) {}

Exception() [3/8]

Exception::Exception	(	std::string const &	aCategory,
		std::string const &	message
	)

Definition at line 18 of file Exception.cc.

References init(), and message().

      : std::exception(), ost_(), category_(aCategory), what_(), context_(), additionalInfo_(), alreadyPrinted_(false) {
    init(message);
  }

Exception() [4/8]

Exception::Exception	(	char const *	aCategory,
		std::string const &	message
	)

Definition at line 23 of file Exception.cc.

References init(), and message().

      : std::exception(),
        ost_(),
        category_(std::string(aCategory)),
        what_(),
        context_(),
        additionalInfo_(),
        alreadyPrinted_(false) {
    init(message);
  }

Exception() [5/8]

Exception::Exception	(	std::string const &	aCategory,
		char const *	message
	)

Definition at line 34 of file Exception.cc.

References init(), message(), and AlCaHLTBitMon_QueryRunRegistry::string.

      : std::exception(), ost_(), category_(aCategory), what_(), context_(), additionalInfo_(), alreadyPrinted_(false) {
    init(std::string(message));
  }

Exception() [6/8]

Exception::Exception	(	char const *	aCategory,
		char const *	message
	)

Definition at line 39 of file Exception.cc.

References init(), message(), and AlCaHLTBitMon_QueryRunRegistry::string.

      : std::exception(),
        ost_(),
        category_(std::string(aCategory)),
        what_(),
        context_(),
        additionalInfo_(),
        alreadyPrinted_(false) {
    init(std::string(message));
  }

Exception() [7/8]

Exception::Exception	(	std::string const &	aCategory,
		std::string const &	message,
		Exception const &	another
	)

Definition at line 59 of file Exception.cc.

References append(), message(), and ost_.

      : std::exception(),
        ost_(),
        category_(aCategory),
        what_(),
        context_(another.context()),
        additionalInfo_(another.additionalInfo()),
        alreadyPrinted_(false) {
    ost_ << message;
    // check for newline at end of message first
    if (!message.empty() && message[message.size() - 1] != '\n') {
      ost_ << "\n";
    }
    append(another);
  }

Exception() [8/8]

Exception::Exception

(

Exception const &

other

)

Definition at line 75 of file Exception.cc.

References ost_, and trackingPlots::other.

      : std::exception(),
        ost_(),
        category_(other.category_),
        what_(other.what_),
        context_(other.context_),
        additionalInfo_(other.additionalInfo_),
        alreadyPrinted_(other.alreadyPrinted_.load()) {
    ost_ << other.ost_.str();
  }

~Exception()

Exception::~Exception ( )

overridenoexcept

Definition at line 86 of file Exception.cc.

{}

Member Function Documentation

addAdditionalInfo() [1/2]

void Exception::addAdditionalInfo

(

std::string const &

info

)

Definition at line 173 of file Exception.cc.

References additionalInfo_, and info().

Referenced by edm::ThinnedAssociationsHelper::addAssociation(), XrdAdaptor::RequestManager::addConnections(), edm::detail::annotateResolverMakerExceptionAndRethrow(), XrdAdaptor::ClientRequest::HandleResponse(), XrdAdaptor::RequestManager::initialize(), edm::RootInputFileSequence::initTheFile(), operator<<(), DQMRootSource::readFile_(), XrdAdaptor::RequestManager::requestFailure(), and XrdAdaptor::RequestManager::splitClientRequest().

{ additionalInfo_.push_back(info); }

addAdditionalInfo() [2/2]

void Exception::addAdditionalInfo

(

char const *

info

)

Definition at line 175 of file Exception.cc.

References additionalInfo_, info(), and AlCaHLTBitMon_QueryRunRegistry::string.

{ additionalInfo_.push_back(std::string(info)); }

addContext() [1/2]

void Exception::addContext

(

std::string const &

context

)

Definition at line 169 of file Exception.cc.

References context(), and context_.

Referenced by edm::storage::DavixFile::abort(), edm::ThinnedAssociationsHelper::addAssociation(), edm::addContextAndPrintException(), edm::UnscheduledCallProducer::addContextToException(), edm::ProductRegistry::addElementTypesForAliases(), edm::eventsetup::ComponentFactory< T >::addTo(), edm::eventsetup::ComponentMaker< edm::eventsetup::LooperMakerTraits, TType >::addTo(), edm::eventsetup::EventSetupRecordImpl::addTraceInfoToCmsException(), edm::eventsetup::EventSetupRecord::addTraceInfoToCmsException(), L1GlobalTriggerObjectMaps::algorithmResult(), L1GlobalTriggerObjectMaps::AlgorithmResult::AlgorithmResult(), CompareToObjectMapRecord::analyze(), edm::EventProcessor::beginJob(), edm::Worker::beginJob(), edm::Worker::beginStream(), edm::storage::LocalCacheFile::cache(), edm::storage::DavixStorageMaker::check(), ALPAKA_ACCELERATOR_NAMESPACE::detail::chooseDevice(), cms::cuda::chooseDevice(), cms::alpakatools::chooseDevice(), edm::storage::DavixFile::close(), L1GlobalTriggerObjectMaps::consistencyCheck(), edm::serviceregistry::ServicesManager::createServiceFor(), edm::service::SiteLocalConfigService::dataCatalogs(), edm::eventsetup::ESSourceProductResolverBase::doPrefetchAndSignals(), edm::Worker::endJob(), edm::Worker::endStream(), edm::service::AsyncService::ensureAllowed(), edm::exceptionContext(), edm::Path::exceptionContext(), edm::Schedule::fillModuleAndConsumesInfo(), edm::InputFileCatalog::findFile(), edm::StreamSchedule::finishedPaths(), edm::storage::XrdFile::getActiveFile(), XrdAdaptor::RequestManager::getActiveFile(), L1GlobalTriggerObjectMaps::getCombinationsInCondition(), L1GlobalTriggerObjectMaps::ConditionsInAlgorithm::getConditionResult(), L1GlobalTriggerObjectMaps::CombinationsInCondition::getObjectIndex(), edm::eventsetup::DependentRecordImplementation< EcalMappingRcd, edm::mpl::Vector< EcalMappingElectronicsRcd > >::getRecord(), L1GlobalTriggerObjectMaps::getStartEndIndex(), fwlite::DataGetterHelper::getThinnedKeyFrom(), BareRootProductGetter::getThinnedKeyFrom(), edm::EventPrincipal::getThinnedKeyFrom(), edm::shared_memory::WriteBuffer::growBuffer(), XrdAdaptor::Source::handle(), XrdAdaptor::RequestManager::handle(), XrdAdaptor::ClientRequest::HandleResponse(), XrdAdaptor::RequestManager::OpenHandler::HandleResponseWithHosts(), edm::FileLocator::init(), edm::InputFileCatalog::init(), edm::BranchDescription::initFromDictionary(), XrdAdaptor::RequestManager::initialize(), edm::RootInputFileSequence::initTheFile(), l1t::L1TGlobalUtilHelper::L1TGlobalUtilHelper(), edm::storage::LocalCacheFile::LocalCacheFile(), edm::eventsetup::CallbackExternalWork< T, TAcquireFunc, TAcquireReturn, TProduceFunc, TProduceReturn, TRecord, TDecorator >::makeAcquireTask(), edm::makeInput(), nowrite(), edm::storage::DCacheFile::open(), edm::storage::DavixFile::open(), edm::storage::XrdFile::open(), XrdAdaptor::RequestManager::OpenHandler::open(), edm::streamer::StreamerInputFile::openStreamerFile(), operator<<(), edm::service::SiteLocalConfigService::parse(), XrdAdaptor::RequestManager::pickSingleSource(), edm::storage::DavixFile::position(), edm::storage::DCacheFile::position(), edm::storage::XrdFile::position(), ConvertObjectMapRecord::produce(), edm::storage::DavixFile::read(), edm::storage::DCacheFile::read(), edm::storage::XrdFile::read(), DQMTTreeIO::TreeObjectReader< T >::read(), edm::streamer::StreamerInputFile::readBytes(), DQMRootSource::readFile_(), edm::storage::DCacheFile::readv(), edm::storage::DavixFile::readv(), edm::storage::XrdFile::readv(), edm::Worker::registerThinnedAssociations(), XrdAdaptor::RequestManager::requestFailure(), edm::storage::DavixFile::resize(), edm::storage::XrdFile::resize(), tensorflow::Options::setBackend(), edm::storage::XrdStorageMaker::setDebugLevel(), edm::streamer::StreamerInputFile::skipBytes(), XrdAdaptor::RequestManager::splitClientRequest(), edm::storage::DCacheStorageMaker::stagein(), edm::service::SiteLocalConfigService::storageDescriptionPath(), edm::Maker::throwConfigurationException(), throwStorageError(), edm::Maker::throwValidationException(), cms::alpakatools::toBackend(), cms::alpakatools::toString(), edm::service::SiteLocalConfigService::trivialDataCatalogs(), L1GlobalTriggerObjectMaps::updateOperandTokenVector(), edm::validateTopLevelParameterSets(), edm::storage::DavixFile::write(), edm::storage::DCacheFile::write(), edm::storage::XrdFile::write(), edm::ConfigurationDescriptions::writeCfiForLabel(), and edm::RootOutputFile::writeIndexIntoFile().

{ context_.push_back(context); }

addContext() [2/2]

void Exception::addContext

(

char const *

context

)

Definition at line 171 of file Exception.cc.

References context(), context_, and AlCaHLTBitMon_QueryRunRegistry::string.

{ context_.push_back(std::string(context)); }

additionalInfo()

std::list< std::string > const & Exception::additionalInfo

(

)

const

Definition at line 153 of file Exception.cc.

References additionalInfo_.

{ return additionalInfo_; }

alreadyPrinted()

bool Exception::alreadyPrinted

(

)

const

Definition at line 181 of file Exception.cc.

References alreadyPrinted_.

{ return alreadyPrinted_.load(); }

append() [1/3]

void Exception::append

(

Exception const &

another

)

Definition at line 157 of file Exception.cc.

References message(), and ost_.

Referenced by diclist.diclist::add(), edm::eventsetup::NoDataExceptionBase::constructMessage(), Exception(), StripClusterizerAlgorithm::InvalidChargeException::InvalidChargeException(), edm::eventsetup::MakeDataException::MakeDataException(), and edm::eventsetup::makeEventSetupProvider().

{ ost_ << another.message(); }

append() [2/3]

void Exception::append

(

std::string const &

more_information

)

Definition at line 159 of file Exception.cc.

References ost_.

Referenced by diclist.diclist::add().

{ ost_ << more_information; }

append() [3/3]

void Exception::append

(

char const *

more_information

)

Definition at line 161 of file Exception.cc.

References ost_.

Referenced by diclist.diclist::add().

{ ost_ << more_information; }

category()

std::string const & Exception::category

(

void

)

const

Definition at line 147 of file Exception.cc.

References category_.

Referenced by TritonException::convertToWarning(), main(), CachedTrajectory::propagate(), edm::Worker::shouldRethrowException(), and TrajectoryStateClosestToPoint::TrajectoryStateClosestToPoint().

{ return category_; }

clearAdditionalInfo()

void Exception::clearAdditionalInfo

(

)

Definition at line 167 of file Exception.cc.

References additionalInfo_.

Referenced by XrdAdaptor::RequestManager::initialize().

{ additionalInfo_.clear(); }

clearContext()

void Exception::clearContext

(

)

Definition at line 165 of file Exception.cc.

References context_.

Referenced by XrdAdaptor::RequestManager::initialize().

{ context_.clear(); }

clearMessage()

void Exception::clearMessage

(

)

Definition at line 163 of file Exception.cc.

References ost_.

Referenced by XrdAdaptor::RequestManager::initialize(), and edm::streamer::StreamerInputFile::openStreamerFile().

{ ost_.str(""); }

clone()

Exception * Exception::clone ( void  ) const

virtual

Reimplemented in edm::Exception, and edm::MultipleException.

Definition at line 185 of file Exception.cc.

References Exception().

Referenced by edm::ExceptionCollector::call(), and edm::Path::workerFinished().

{ return new Exception(*this); }

context()

std::list< std::string > const & Exception::context

(

)

const

Definition at line 151 of file Exception.cc.

References context_.

Referenced by addContext(), edm::StreamSchedule::finishedPaths(), edm::StreamSchedule::finishProcessOneEvent(), edm::GlobalSchedule::processOneGlobalAsync(), edm::StreamSchedule::processOneStreamAsync(), setContext(), and edm::SecondaryEventProvider::setupPileUpEvent().

{ return context_; }

explainSelf()

std::string Exception::explainSelf ( ) const

virtual

Definition at line 112 of file Exception.cc.

References additionalInfo_, HltBtagPostValidation_cff::c, category_, context_, submitPVResolutionJobs::count, mps_fire::i, ost_, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by edm::ExceptionCollector::call(), TritonException::convertToWarning(), L1GtUtils::LogicalExpressionL1Results::initialize(), CachedTrajectory::propagate(), TrajectoryStateClosestToPoint::TrajectoryStateClosestToPoint(), and what().

                                         {
    std::ostringstream ost;

    if (context_.empty()) {
      ost << "An exception of category '" << category_ << "' occurred.\n";
    } else {
      ost << "An exception of category '" << category_ << "' occurred while\n";
      int count = 0;
      for (std::list<std::string>::const_reverse_iterator i = context_.rbegin(), iEnd = context_.rend(); i != iEnd;
           ++i, ++count) {
        ost << "   [" << count << "] " << *i << "\n";
      }
    }

    std::string centralMessage(ost_.str());
    if (!centralMessage.empty()) {
      ost << "Exception Message:\n";
      ost << centralMessage;
      if (centralMessage[centralMessage.size() - 1] != '\n') {
        ost << "\n";
      }
    }

    if (!additionalInfo_.empty()) {
      ost << "   Additional Info:\n";
      char c = 'a';
      for (std::list<std::string>::const_reverse_iterator i = additionalInfo_.rbegin(), iEnd = additionalInfo_.rend();
           i != iEnd;
           ++i, ++c) {
        ost << "      [" << c << "] " << *i << "\n";
      }
    }
    return ost.str();
  }

history()

std::list< std::string > Exception::history

(

)

const

Definition at line 191 of file Exception.cc.

References category_.

                                              {
    std::list<std::string> returnValue;
    returnValue.push_back(category_);
    return returnValue;
  }

init()

void Exception::init ( std::string const &  message )

private

Definition at line 50 of file Exception.cc.

References message(), and ost_.

Referenced by Exception().

                                               {
    ost_ << message;
    if (!message.empty()) {
      unsigned sz = message.size() - 1;
      if (message[sz] != '\n' && message[sz] != ' ')
        ost_ << " ";
    }
  }

message()

std::string Exception::message

(

)

const

Definition at line 149 of file Exception.cc.

References ost_.

Referenced by append(), edm::eventsetup::NoDataExceptionBase::constructMessage(), Exception(), and init().

{ return ost_.str(); }

operator=()

Exception & Exception::operator=

(

Exception const &

other

)

Definition at line 101 of file Exception.cc.

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

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

raise()

void cms::Exception::raise ( )

inline

Definition at line 90 of file Exception.h.

Referenced by HLTBTagHarvestingAnalyzer::GetNumDenumerators().

{ rethrow(); }

rethrow()

void Exception::rethrow ( )

privatevirtual

Reimplemented in edm::Exception.

Definition at line 187 of file Exception.cc.

{ throw *this; }

returnCode()

int Exception::returnCode

(

)

const

Definition at line 155 of file Exception.cc.

References returnCode_().

Referenced by edm::addContextAndPrintException(), and edm::ExceptionCollector::call().

{ return returnCode_(); }

returnCode_()

int Exception::returnCode_ ( ) const

privatevirtual

Reimplemented in edm::Exception, and edm::MultipleException.

Definition at line 189 of file Exception.cc.

Referenced by returnCode().

{ return 8001; }

setAdditionalInfo()

void Exception::setAdditionalInfo

(

std::list< std::string > const &

info

)

Definition at line 179 of file Exception.cc.

References additionalInfo_, and info().

{ additionalInfo_ = info; }

setAlreadyPrinted()

void Exception::setAlreadyPrinted

(

)

Definition at line 183 of file Exception.cc.

References alreadyPrinted_.

Referenced by edm::addContextAndPrintException().

{ alreadyPrinted_.exchange(true); }

setContext()

void Exception::setContext

(

std::list< std::string > const &

context

)

Definition at line 177 of file Exception.cc.

References context(), and context_.

{ context_ = context; }

swap()

void Exception::swap

(

Exception &

other

)

Definition at line 88 of file Exception.cc.

References additionalInfo_, alreadyPrinted_, category_, context_, ost_, trackingPlots::other, groupFilesInBlocks::temp, and what_.

Referenced by operator=().

                                       {
    ost_ << other.ost_.str();
    category_.swap(other.category_);
    what_.swap(other.what_);
    context_.swap(other.context_);
    additionalInfo_.swap(other.additionalInfo_);
    // It is not possible to atomically swap atomics
    // This should be good enough for current use cases.
    bool temp = alreadyPrinted_.load();
    alreadyPrinted_ = other.alreadyPrinted_.load();
    other.alreadyPrinted_ = temp;
  }

what()

char const * Exception::what ( ) const

overridenoexcept

Definition at line 107 of file Exception.cc.

References explainSelf(), and what_.

Referenced by L1CondDBPayloadWriterExt::analyze(), SiStripDetVOffFakeBuilder::analyze(), SiPixelLorentzAngleDBLoader::analyze(), SiPixelVCalDB::analyze(), SiPixelLorentzAngleDB::analyze(), SiPixelDynamicInefficiencyDB::analyze(), DiMuonVertexMonitor::analyze(), L1CondDBPayloadWriter::analyze(), cms::SiPixelCondObjBuilder::analyze(), cms::SiPixelCondObjForHLTBuilder::analyze(), cms::SiPixelCondObjOfflineBuilder::analyze(), DiMuonVertexValidation::analyze(), PrimaryVertexValidation::analyze(), FWPFCandidateDetailView::build(), FWPFPatJet3DProxyBuilder< reco::PFJet >::build(), FWPFCandidateDetailView::buildGLEventScene(), magneticfield::MagGeoBuilder::buildInterpolator(), MagGeoBuilderFromDDD::buildInterpolator(), SiPixelGainCalibScaler::computeAndStorePalyoads(), SiStripLorentzAnglePCLHarvester::dqmEndJob(), SiPixelLorentzAnglePCLHarvester::dqmEndJob(), SiPixelLorentzAnglePCLHarvesterMCS::dqmEndJob(), FWModelChangeManager::endChanges(), edm::shared_memory::WriteBuffer::growBuffer(), edm::MessageLoggerQ::handshakedCommand(), L1GtUtils::LogicalExpressionL1Results::initialize(), PhotonConversionTrajectorySeedProducerFromQuadrupletsAlgo::inspect(), main(), Vx3DHLTAnalyzer::MyFit(), cond::XMLAuthenticationService::XMLAuthenticationService::processFile(), PhotonConversionTrajectorySeedProducerFromQuadruplets::produce(), CaloTruthCellsProducer::produce(), edm::storage::XrdFile::readv(), and DTCalibDBUtils::writeToDB().

                                             {
    what_ = explainSelf();
    return what_.c_str();
  }

Friends And Related Function Documentation

operator<< [1/3]

template<typename E , typename T >

detail::exception_type<E>& operator<< ( E &&  e, T const &  stuff  )

friend

Definition at line 156 of file Exception.h.

                                                                             {
    e.ost_ << stuff;
    return e;
  }

operator<< [2/3]

template<typename E >

detail::exception_type<E>& operator<< ( E &&  e, std::ostream &(*)(std::ostream &)  f  )

friend

Definition at line 162 of file Exception.h.

                                                                                            {
    f(e.ost_);
    return e;
  }

operator<< [3/3]

template<typename E >

detail::exception_type<E>& operator<< ( E &&  e, std::ios_base &(*)(std::ios_base &)  f  )

friend

Definition at line 168 of file Exception.h.

                                                                                              {
    f(e.ost_);
    return e;
  }

Member Data Documentation

additionalInfo_

std::list<std::string> cms::Exception::additionalInfo_

private

Definition at line 144 of file Exception.h.

Referenced by addAdditionalInfo(), additionalInfo(), clearAdditionalInfo(), explainSelf(), setAdditionalInfo(), and swap().

alreadyPrinted_

std::atomic<bool> cms::Exception::alreadyPrinted_

private

Definition at line 145 of file Exception.h.

Referenced by alreadyPrinted(), setAlreadyPrinted(), and swap().

category_

std::string cms::Exception::category_

private

Definition at line 140 of file Exception.h.

Referenced by category(), explainSelf(), history(), and swap().

context_

std::list<std::string> cms::Exception::context_

private

Definition at line 143 of file Exception.h.

Referenced by addContext(), clearContext(), context(), explainSelf(), setContext(), and swap().

ost_

std::ostringstream cms::Exception::ost_

private

Definition at line 139 of file Exception.h.

Referenced by append(), clearMessage(), Exception(), explainSelf(), init(), message(), and swap().

what_

std::string cms::Exception::what_

mutableprivate

Definition at line 142 of file Exception.h.

Referenced by swap(), and what().