ELdestControl.h

Go to the documentation of this file.

#ifndef FWCore_MessageService_ELdestControl_h
#define FWCore_MessageService_ELdestControl_h


// ----------------------------------------------------------------------
//
// ELdestControl  is a handle class whose purpose is to dispatch orders
//                from the framework to an ELdestination, without
//                allowing the framework to destruct that instance of the
//                destination (which would be a disasterous way to foul up).
//                The ELadministrator creates an ELdestControl handle
//                to its own copy whenever an ELdestination is attached.
//
// 7/5/98  mf   Created file.
// 6/16/99 jvr  Allows suppress/include options on destinations
// 7/2/99  jvr  Added separate/attachTime, Epilogue, and Serial options
// 6/7/00  web  Reflect consolidation of ELdestination/X; add
//      filterModule()
// 10/04/00 mf  add excludeModule()
// 01/15/00 mf  mods to give user control of line length
// 03/13/01 mf  mod to give user control of hex trigger and 
//      statisticsMap() method
// 04/04/01 mf  add ignoreMOdule and respondToModule
// 10/17/01 mf  add setTableLimit which had been omitted
// 10/18/01 mf  Corrected default in summary title =0 to empty string
//  6/23/03 mf  changeFile() and flush() 
//  6/19/08 mf  summaryForJobReport()
//
// ----------------------------------------------------------------------


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

#include "boost/shared_ptr.hpp"


namespace edm {       
namespace service {       

// ----------------------------------------------------------------------
// prerequisite classes:
// ----------------------------------------------------------------------

class ELdestination;

// ----------------------------------------------------------------------
// ELdestControl:
// ----------------------------------------------------------------------

class ELdestControl  {

public:
  ELdestControl( boost::shared_ptr<ELdestination> dest );
  ELdestControl();
  virtual ~ELdestControl();

  // -----  Behavior control methods invoked by the framework:
  //
  virtual ELdestControl & setThreshold( const ELseverityLevel & sv );
  virtual ELdestControl & setTraceThreshold( const ELseverityLevel & sv );
  virtual ELdestControl & setLimit( const ELstring & s, int n );
  virtual ELdestControl & setLimit( const ELseverityLevel & sv, int n );
  virtual ELdestControl & setInterval( const ELstring & s, int interval );
  virtual ELdestControl & setInterval( const ELseverityLevel& sv, int interval);
  virtual ELdestControl & setTimespan( const ELstring& s, int n );
  virtual ELdestControl & setTimespan( const ELseverityLevel & sv, int n );

  virtual ELdestControl & setTableLimit( int n );

  // -----  Select output format options:
  //
  virtual void suppressText();           virtual void includeText();  // $$ jvr
  virtual void suppressModule();         virtual void includeModule();
  virtual void suppressSubroutine();     virtual void includeSubroutine();
  virtual void suppressTime();           virtual void includeTime();
  virtual void suppressContext();        virtual void includeContext();
  virtual void suppressSerial();         virtual void includeSerial();
  virtual void useFullContext();         virtual void useContext();
  virtual void separateTime();           virtual void attachTime();
  virtual void separateEpilogue();       virtual void attachEpilogue();
  virtual void noTerminationSummary();
  virtual int  setLineLength(int len);   virtual int  getLineLength() const;

  virtual void filterModule    ( ELstring const & moduleName );
  virtual void excludeModule   ( ELstring const & moduleName );
  virtual void respondToModule ( ELstring const & moduleName );
  virtual void ignoreModule    ( ELstring const & moduleName );

  virtual ELdestControl & clearSummary();
  virtual ELdestControl & wipe();
  virtual ELdestControl & zero();

  virtual ELdestControl & setPreamble( const ELstring & preamble );
  virtual ELdestControl & setNewline( const ELstring & newline );

  // -----  Active methods invoked by the framework:
  //
  virtual void summary( ELdestControl & dest, char * title="" );
  virtual void summary( std::ostream  & os  , char * title="" );
  virtual void summary( ELstring      & s   , char * title="" );
  virtual void summary( );
  virtual void summaryForJobReport( std::map<std::string, double> & sm);

  virtual std::map<ELextendedID , StatsCount> statisticsMap() const;

  virtual bool log( edm::ErrorObj & msg );  // Backdoor to log a formed message
                                            // to only this destination.
                       
  virtual void changeFile (std::ostream & os);
  virtual void changeFile (const ELstring & filename);
  virtual void flush();                        
  
  // -----  Helper methods invoked by other ErrorLogger classes

  virtual void summarization( const ELstring & title
                            , const ELstring & sumLines
                            );

  ELstring getNewline() const;

  // -----  Data implementing the trivial handle pattern:
  //
protected:
  boost::shared_ptr<ELdestination> d;

};  // ELdestControl


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


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


#endif // FWCore_MessageService_ELdestControl_h