StatusCodeSvc Class Reference

#include <src/StatusCodeSvc.h>

Inheritance diagram for StatusCodeSvc:

Collaboration diagram for StatusCodeSvc:

Classes
struct	StatCodeDat

Public Member Functions
virtual StatusCode	initialize ()
	Initialization (from CONFIGURED to INITIALIZED). More...
virtual StatusCode	reinitialize ()
	Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED). More...
virtual StatusCode	finalize ()
	Finalize (from INITIALIZED to CONFIGURED). More...
virtual void	regFnc (const std::string &func, const std::string &lib)
virtual void	list () const
virtual bool	suppressCheck () const
	StatusCodeSvc (const std::string &name, ISvcLocator *svc)
virtual	~StatusCodeSvc ()
Public Member Functions inherited from extends1< Service, IStatusCodeSvc >
	extends1 (A1 a1, A2 a2, A3 a3)
	Templated constructor with 3 arguments. More...
	extends1 (A1 a1, A2 a2)
	Templated constructor with 2 arguments. More...
	extends1 (A1 a1)
	Templated constructor with 1 argument. More...
	extends1 ()
	Default constructor. More...
virtual void *	i_cast (const InterfaceID &tid) const
	Implementation of IInterface::i_cast. More...
virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)
	Implementation of IInterface::queryInterface. More...
virtual std::vector< std::string >	getInterfaceNames () const
	Implementation of IInterface::getInterfaceNames. More...
virtual	~extends1 ()
	Virtual destructor. More...
Public Member Functions inherited from Service
virtual unsigned long	release ()
	Release Interface instance. More...
virtual const std::string &	name () const
	Retrieve name of the service. More...
virtual StatusCode	configure ()
	Configuration (from OFFLINE to CONFIGURED). More...
virtual StatusCode	start ()
	Start (from INITIALIZED to RUNNING). More...
virtual StatusCode	stop ()
	Stop (from RUNNING to INITIALIZED). More...
virtual StatusCode	terminate ()
	Initialization (from CONFIGURED to OFFLINE). More...
virtual Gaudi::StateMachine::State	FSMState () const
	Get the current state. More...
virtual Gaudi::StateMachine::State	targetFSMState () const
	When we are in the middle of a transition, get the state where the transition is leading us. More...
virtual StatusCode	restart ()
	Initialization (from RUNNING to RUNNING, via INITIALIZED). More...
virtual StatusCode	sysInitialize ()
	Initialize Service. More...
virtual StatusCode	sysStart ()
	Initialize Service. More...
virtual StatusCode	sysStop ()
	Initialize Service. More...
virtual StatusCode	sysFinalize ()
	Finalize Service. More...
virtual StatusCode	sysReinitialize ()
	Re-initialize the Service. More...
virtual StatusCode	sysRestart ()
	Re-initialize the Service. More...
virtual StatusCode	setProperty (const Property &p)
	Set the property by property. More...
virtual StatusCode	setProperty (const std::string &s)
	Set the property by string. More...
virtual StatusCode	setProperty (const std::string &n, const std::string &v)
	Set the property by std::string. More...
virtual StatusCode	getProperty (Property *p) const
	Get the property by property. More...
virtual const Property &	getProperty (const std::string &name) const
	Get the property by name. More...
virtual StatusCode	getProperty (const std::string &n, std::string &v) const
	Get the property by std::string. More...
virtual const std::vector < Property * > &	getProperties () const
	Get list of properties. More...
template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...
	Service (const std::string &name, ISvcLocator *svcloc)
	Standard Constructor. More...
SmartIF< ISvcLocator > &	serviceLocator () const
	Retrieve pointer to service locator. More...
StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job. More...
template<class T >
StatusCode	service (const std::string &name, const T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...
template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const
template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...
template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...
Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...
SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...
Public Member Functions inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
	CommonMessaging (const A1 &a1, const A2 &a2, const A3 &a3)
	Templated constructor with 3 arguments. More...
	CommonMessaging (const A1 &a1, const A2 &a2)
	Templated constructor with 2 arguments. More...
	CommonMessaging (const A1 &a1)
	Templated constructor with 1 argument. More...
	CommonMessaging ()
	Default constructor. More...
virtual	~CommonMessaging ()
	Virtual destructor. More...
SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...
MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...
MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...
MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...
MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...
MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...
MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...
MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...
MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...
MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...
MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...
MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) More...
MSG::Level	msgLevel () const
	get the output level from the embedded MsgStream More...
bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...
Public Member Functions inherited from extend_interfaces3< IService, IProperty, IStateful >
virtual	~extend_interfaces3 ()
	Virtual destructor. More...
Public Member Functions inherited from IService
	DeclareInterfaceID (IService, 3, 0)
	InterfaceID. More...
virtual	~IService ()
	virtual destructor More...
Public Member Functions inherited from INamedInterface
	DeclareInterfaceID (INamedInterface, 1, 0)
	InterfaceID. More...
virtual	~INamedInterface ()
	Virtual destructor (always needed for abstract classes). More...
Public Member Functions inherited from IInterface
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...
virtual unsigned long	refCount () const =0
	Current reference count. More...
virtual	~IInterface ()
	Virtual destructor. More...
Public Member Functions inherited from IProperty
	DeclareInterfaceID (IProperty, 2, 0)
	InterfaceID. More...
Public Member Functions inherited from IStateful
	DeclareInterfaceID (IStateful, 1, 0)
	InterfaceID. More...
virtual	~IStateful ()
Public Member Functions inherited from extend_interfaces1< IStatusCodeSvc >
virtual	~extend_interfaces1 ()
	Virtual destructor. More...
Public Member Functions inherited from IStatusCodeSvc
	DeclareInterfaceID (IStatusCodeSvc, 2, 0)
	InterfaceID. More...
virtual	~IStatusCodeSvc ()
	virtual destructor More...

Private Member Functions
void	parseFilter (const std::string &str, std::string &fnc, std::string &lib)
void	filterFnc (const std::string &)
void	filterLib (const std::string &)

Private Attributes
StringArrayProperty	m_pFilter
BooleanProperty	m_abort
BooleanProperty	m_suppress
BooleanProperty	m_dict
std::map< std::string, StatCodeDat >	m_dat
std::set< std::string >	m_filterfnc
std::set< std::string >	m_filterlib

Additional Inherited Members
Public Types inherited from extends1< Service, IStatusCodeSvc >
typedef extends1	base_class
	Typedef to this class. More...
typedef extend_interfaces1 < IStatusCodeSvc >	extend_interfaces_base
	Typedef to the base of this class. More...
typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...
Public Types inherited from Service
typedef Gaudi::PluginService::Factory < IService *, const std::string &, ISvcLocator * >	Factory
Public Types inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
typedef CommonMessaging	base_class
Public Types inherited from implements3< IService, IProperty, IStateful >
typedef implements3	base_class
	Typedef to this class. More...
typedef extend_interfaces3 < IService, IProperty, IStateful >	extend_interfaces_base
	Typedef to the base of this class. More...
typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...
Public Types inherited from extend_interfaces3< IService, IProperty, IStateful >
typedef mpl::fold< typename IService::iid::iids::type, typename mpl::fold< typename IProperty::iid::iids::type, typename IStateful::iid::iids::type, mpl::insert< mpl::_1, mpl::_2 > >::type, mpl::insert< mpl::_1, mpl::_2 > >::type	ext_iids
	MPL set of interfaces extended by this one. More...
Public Types inherited from IInterface
enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...
typedef Gaudi::InterfaceId < IInterface, 0, 0 >	iid
	Interface ID. More...
typedef mpl::set1< iid >	ext_iids
	Extra interfaces. More...
Public Types inherited from extend_interfaces1< IStatusCodeSvc >
typedef IStatusCodeSvc::iid::iids::type	ext_iids
	MPL set of interfaces extended by this one. More...
Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...
Protected Member Functions inherited from Service
virtual	~Service ()
	Standard Destructor. More...
int	outputLevel () const
	get the Service's output level More...
Protected Member Functions inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...
Protected Attributes inherited from Service
IntegerProperty	m_outputLevel
	Service output level. More...
Gaudi::StateMachine::State	m_state
	Service state. More...
Gaudi::StateMachine::State	m_targetState
	Service state. More...
Protected Attributes inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
SmartIF< IMessageSvc >	m_msgsvc
	Pointer to the message service;. More...
std::auto_ptr< MsgStream >	m_msgStream
	The predefined message stream. More...
bool	m_streamWithService
	Flag to create a new MsgStream if it was created without the message service. More...

Detailed Description

Definition at line 12 of file StatusCodeSvc.h.

Constructor & Destructor Documentation

StatusCodeSvc::StatusCodeSvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

Definition at line 17 of file StatusCodeSvc.cpp.

  : base_class( name, svc )
{

  declareProperty("Filter",m_pFilter);
  declareProperty("AbortOnError",m_abort=false);
  declareProperty("SuppressCheck", m_suppress=false);
  declareProperty("IgnoreDicts",m_dict=true);

}

StatusCodeSvc::~StatusCodeSvc ( )

virtual

Definition at line 30 of file StatusCodeSvc.cpp.

                              {

}

Member Function Documentation

void StatusCodeSvc::filterFnc ( const std::string &  str )

private

Definition at line 199 of file StatusCodeSvc.cpp.

                                             {

  std::map<std::string, StatCodeDat>::iterator itr;
  for (itr = m_dat.begin(); itr != m_dat.end(); ++itr ) {
    if (itr->second.fnc == str) {
      m_dat.erase(itr);
      return;
    }

  }

}

void StatusCodeSvc::filterLib ( const std::string &  str )

private

Definition at line 214 of file StatusCodeSvc.cpp.

                                             {

  std::map<std::string, StatCodeDat>::iterator itr;
  for (itr = m_dat.begin(); itr != m_dat.end(); ++itr ) {
    if (itr->second.lib == str) {
      m_dat.erase(itr);
      return;
    }

  }

}

StatusCode StatusCodeSvc::finalize ( )

virtual

Finalize (from INITIALIZED to CONFIGURED).

Reimplemented from Service.

Definition at line 83 of file StatusCodeSvc.cpp.

                        {

  if (m_dat.size() > 0) {
    MsgStream log( msgSvc(), name() );

    log << MSG::INFO << "listing all unchecked return codes:" << endmsg;

    list();

  }

  return StatusCode::SUCCESS;

}

StatusCode StatusCodeSvc::initialize ( )

virtual

Initialization (from CONFIGURED to INITIALIZED).

Reimplemented from Service.

Definition at line 38 of file StatusCodeSvc.cpp.

                          {

  StatusCode sc = Service::initialize();
  if (!sc.isSuccess()) return sc;

  MsgStream log( msgSvc(), name() );
  log << MSG::INFO << "initialize" << endmsg;

  std::vector<std::string>::const_iterator itr;
  for (itr = m_pFilter.value().begin(); itr != m_pFilter.value().end(); ++itr) {
    // we need to do this if someone has gotten to regFnc before initialize

    string fnc,lib;
    parseFilter(*itr,fnc,lib);

    if (fnc != "") {
      filterFnc(fnc);
      m_filterfnc.insert(fnc);
    }

    if (lib != "") {
      filterLib(lib);
      m_filterlib.insert(lib);
    }

  }

  return StatusCode::SUCCESS;

}

void StatusCodeSvc::list ( ) const

virtual

Implements IStatusCodeSvc.

Definition at line 153 of file StatusCodeSvc.cpp.

                          {

  MsgStream log( msgSvc(), name() );
  log << MSG::INFO << endl;

  map<string,StatCodeDat>::const_iterator itr;

#if defined (__GNUC__) && ( __GNUC__ <= 2 )
  std::ostrstream os;
#else
  std::ostringstream os;
#endif

  os << "Num | Function                       | Source Library" << endl;
  os << "----+--------------------------------+-------------------"
     << "-----------------------" << endl;


  for(itr = m_dat.begin(); itr != m_dat.end(); ++itr ) {
    StatCodeDat dat = itr->second;

    os.width(3);
    os.setf(ios_base::right,ios_base::adjustfield);
    os << dat.count;

    os << " | ";
    os.width(30);
    os.setf(ios_base::left,ios_base::adjustfield);
    os << dat.fnc;

    os << " | ";
    os.setf(ios_base::left,ios_base::adjustfield);
    os << dat.lib;

    os << endl;

  }


  log << os.str() << endmsg;

}

void StatusCodeSvc::parseFilter ( const std::string &  str, std::string &  fnc, std::string &  lib  )

private

Definition at line 230 of file StatusCodeSvc.cpp.

                                                                      {


  string::size_type loc = str.find("=");
  if (loc == std::string::npos) {
    fnc = str;
    lib = "";
  } else {
    string key,val;
    key = str.substr(0,loc);
    val = str.substr(loc+1,str.length()-loc-1);

    toupper(key);

    if (key == "FCN" || key == "FNC") {
      fnc = val;
      lib = "";
    } else if (key == "LIB") {
      fnc = "";
      lib = val;
    } else {
      fnc = "";
      lib = "";

      MsgStream log( msgSvc(), name() );
      log << MSG::WARNING << "ignoring unknown token in Filter: " << str
      << endmsg;
    }
  }

}

void StatusCodeSvc::regFnc ( const std::string &  func, const std::string &  lib  )

virtual

Implements IStatusCodeSvc.

Definition at line 103 of file StatusCodeSvc.cpp.

                                                                {

  if (m_state == Gaudi::StateMachine::OFFLINE ||
      m_state == Gaudi::StateMachine::CONFIGURED) {
    return;
  }

  if (m_dict && lib.rfind("Dict.so") == (lib.length()-7) ) {
    return;
  }

  {
    const string rlib = lib.substr(lib.rfind("/") + 1);

    if (m_filterfnc.find(fnc) != m_filterfnc.end() ||
        m_filterlib.find(rlib) != m_filterlib.end() ) {
      return;
    }
  }

  if (m_abort) {
    MsgStream log( msgSvc(), name() );
    log << MSG::FATAL << "Unchecked StatusCode in " << fnc << " from lib "
    << lib << endmsg;
    abort();
  }

  string key = fnc + lib;

  map<string,StatCodeDat>::iterator itr = m_dat.find(key);

  if (itr != m_dat.end()) {
    itr->second.count += 1;
  } else {

    const string rlib = lib.substr(lib.rfind("/") + 1);

    StatCodeDat dat;
    dat.fnc = fnc;
    dat.lib = rlib;
    dat.count = 1;

    m_dat[key] = dat;
  }

}

StatusCode StatusCodeSvc::reinitialize ( )

virtual

Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).

Reimplemented from Service.

Definition at line 72 of file StatusCodeSvc.cpp.

                            {

  MsgStream log( msgSvc(), name() );
  log << MSG::INFO << "reinitialize" << endmsg;

  return StatusCode::SUCCESS;

}

virtual bool StatusCodeSvc::suppressCheck ( ) const

inlinevirtual

Implements IStatusCodeSvc.

Definition at line 22 of file StatusCodeSvc.h.

{ return m_suppress.value() ; }

Member Data Documentation

BooleanProperty StatusCodeSvc::m_abort

private

Definition at line 42 of file StatusCodeSvc.h.

std::map<std::string,StatCodeDat> StatusCodeSvc::m_dat

private

Definition at line 44 of file StatusCodeSvc.h.

BooleanProperty StatusCodeSvc::m_dict

private

Definition at line 42 of file StatusCodeSvc.h.

std::set<std::string> StatusCodeSvc::m_filterfnc

private

Definition at line 45 of file StatusCodeSvc.h.

std::set<std::string> StatusCodeSvc::m_filterlib

private

Definition at line 45 of file StatusCodeSvc.h.

StringArrayProperty StatusCodeSvc::m_pFilter

private

Definition at line 41 of file StatusCodeSvc.h.

BooleanProperty StatusCodeSvc::m_suppress

private

Definition at line 42 of file StatusCodeSvc.h.

---

The documentation for this class was generated from the following files:

• GaudiCommonSvc/src/StatusCodeSvc.h
• GaudiCommonSvc/src/StatusCodeSvc.cpp