ELcontextSupplier.h

Go to the documentation of this file.

#ifndef FWCore_MessageService_ELcontextSupplier_h
#define FWCore_MessageService_ELcontextSupplier_h


// ----------------------------------------------------------------------
//
// ELcontextSupplier    a class with a few (pure virtual) methods to
//          provides strings for summary, ordinary, and
//          more verbose full constexts.  The context is
//          meant to convey framework-wide info, such as
//          current run and event.
//
//
//  THIS HEADER FILE DEFINES AN INTERFACE AND IS INCLUDED IN
//  FRAMEWORK CODE THAT OUGHT NOT TO BE FORCED TO RECOMPILE
//  UNNECESSARILY.
//
//  THEREFORE, CHANGES IN THIS FILE SHOULD BE AVOIDED IF POSSIBLE.
//
// 7/7/98 mf    Created file.
// 7/14/98 pgc  Renamed from ELcontextSupplier to ELcontextSupplier
// 9/8/98 web   Minor touch-ups
// 12/20/99 mf  Added virtual destructor.
//
// ----------------------------------------------------------------------


#include "FWCore/MessageLogger/interface/ELstring.h"
#include "FWCore/MessageLogger/interface/ErrorObj.h"

namespace edm {       
namespace service {       

// ----------------------------------------------------------------------
// ELcontextSupplier:
// ----------------------------------------------------------------------

class ELcontextSupplier  {

public:
  virtual ELcontextSupplier * clone()          const = 0;
  virtual ELstring            context()        const = 0;
  virtual ELstring            summaryContext() const = 0;
  virtual ELstring            fullContext()    const = 0;

  virtual void editErrorObj( edm::ErrorObj & msg ) const  { }
  virtual edm::ELstring traceRoutine( ) const  { return edm::ELstring(""); }

  virtual ~ELcontextSupplier()  { ; }

};  // ELcontextSupplier


// ----------------------------------------------------------------------


}        // end of namespace service
}        // end of namespace edm


#endif  // FWCore_MessageService_ELcontextSupplier_h