GaudiException.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#pragma once
 
#include <GaudiKernel/Kernel.h>
#include <GaudiKernel/MsgStream.h>
#include <GaudiKernel/StatusCode.h>
#include <exception>
#include <memory>
#include <ostream>
#include <string>

class GAUDI_API GaudiException : virtual public std::exception {
  friend class StatusCode;
 
public:
  GaudiException( std::string Message, std::string Tag, StatusCode Code );

  GaudiException( std::string Message, std::string Tag, StatusCode Code, const GaudiException& Exception );

  GaudiException( std::string Message, std::string Tag, StatusCode Code, const std::exception& Exception );

  GaudiException( const GaudiException& Exception );

  virtual ~GaudiException() throw();

  GaudiException& operator=( const GaudiException& Exception );

  virtual const std::string& message() const { return m_message; }

  virtual const std::string& setMessage( const std::string& newMessage ) {
    m_message = newMessage;
    return message();
  }

  virtual const std::string& tag() const { return m_tag; }

  virtual const std::string& setTag( const std::string& newTag ) {
    m_tag = newTag;
    return tag();
  }

  virtual const StatusCode& code() const { return m_code; }

  virtual const StatusCode& setCode( const StatusCode& newStatus ) {
    m_code = newStatus;
    return code();
  }

  virtual GaudiException* previous() const { return m_previous.get(); }

  virtual const std::string& backTrace() const { return m_backTrace; }

  virtual std::ostream& printOut( std::ostream& os = std::cerr ) const;

  virtual MsgStream& printOut( MsgStream& os ) const;

  virtual GaudiException* clone() const { return new GaudiException( *this ); }

  const char* what() const throw() override { return message().c_str(); }

  friend std::ostream& operator<<( std::ostream& os, const GaudiException& ge );

  friend std::ostream& operator<<( std::ostream& os, const GaudiException* pge );

  friend MsgStream& operator<<( MsgStream& os, const GaudiException& ge );

  friend MsgStream& operator<<( MsgStream& os, const GaudiException* pge );
 
protected:
  std::string                     m_message;   
  std::string                     m_tag;       
  StatusCode                      m_code;      
  std::string                     m_backTrace; 
  std::unique_ptr<GaudiException> m_previous;  
  static bool                     s_proc;
};