#include <PyAthenaAud.h>

Inheritance diagram for PyAthena::Aud:

Collaboration diagram for PyAthena::Aud:

Public Member Functions
	Aud (const std::string &name, ISvcLocator *svcLocator)
	Constructor with parameters: More...

virtual	~Aud ()
	Destructor: More...

virtual StatusCode	initialize () override
	Gaudi Aud Implementation. More...

virtual StatusCode	sysInitialize () override

virtual StatusCode	finalize () override

virtual const char *	typeName () const override
	return the `std::type_info` name of the underlying py-component This is used by concrete implementations to connect a python component to its C++ counter-part More...

virtual void	py_before (IAuditor::StandardEventType, const std::string &)
	Audit the start of a standard "event". More...

virtual void	py_before (IAuditor::CustomEventTypeRef, const std::string &)
	Audit the start of a custom "event". More...

virtual void	py_after (IAuditor::StandardEventType, const std::string &, const StatusCode &)
	Audit the end of a standard "event". More...

virtual void	py_after (IAuditor::CustomEventTypeRef, const std::string &, const StatusCode &)
	Audit the end of a custom "event". More...

virtual PyObject *	self () override
	return associated python object. More...

	DeclareInterfaceID (IPyComponent, 1, 0)

Protected Member Functions
virtual bool	setPyAttr (PyObject *pyobj) override
	attach the C++ component to its python cousin More...

virtual void	before (StandardEventType, INamedInterface *) override
	`Auditor` interface More...

virtual void	before (StandardEventType, const std::string &) override

virtual void	before (CustomEventTypeRef, INamedInterface *) override

virtual void	before (CustomEventTypeRef, const std::string &) override

virtual void	after (StandardEventType, INamedInterface *, const StatusCode &) override

virtual void	after (StandardEventType, const std::string &, const StatusCode &) override

virtual void	after (CustomEventTypeRef, INamedInterface *, const StatusCode &) override

virtual void	after (CustomEventTypeRef, const std::string &, const StatusCode &) override

virtual void	beforeInitialize (INamedInterface *) override

virtual void	afterInitialize (INamedInterface *) override

virtual void	beforeReinitialize (INamedInterface *) override

virtual void	afterReinitialize (INamedInterface *) override

virtual void	beforeExecute (INamedInterface *) override

virtual void	afterExecute (INamedInterface *, const StatusCode &) override

virtual void	beforeFinalize (INamedInterface *) override

virtual void	afterFinalize (INamedInterface *) override

Protected Attributes
PyObject *	m_self
	Pointer to self (from the python world) More...

Private Member Functions
	Aud ()
	Default constructor: More...

Detailed Description

Definition at line 30 of file PyAthenaAud.h.

Constructor & Destructor Documentation

◆ Aud() [1/2]

PyAthena::Aud::Aud	(	const std::string &	name,
		ISvcLocator *	svcLocator
	)

Constructor with parameters:

Definition at line 41 of file PyAthenaAud.cxx.

                                                          :
   ::Auditor( name, svcLocator ),
   m_self   ( nullptr )
 {}

◆ ~Aud()

PyAthena::Aud::~Aud ( )

virtual

Destructor:

Definition at line 48 of file PyAthenaAud.cxx.

 { 
   if ( m_self ) {
     RootUtils::PyGILStateEnsure ensure;
     Py_DECREF( m_self );
     m_self = nullptr;
   }
 }

◆ Aud() [2/2]

PyAthena::Aud::Aud ( )

private

Default constructor:

Member Function Documentation

◆ after() [1/4]

void PyAthena::Aud::after	(	CustomEventTypeRef	evt,
		const std::string &	comp,
		const StatusCode &	sc
	)

overrideprotectedvirtual

Definition at line 149 of file PyAthenaAud.cxx.

 {
   py_after (evt, comp, sc);
 }

◆ after() [2/4]

void PyAthena::Aud::after	(	CustomEventTypeRef	evt,
		INamedInterface *	comp,
		const StatusCode &	sc
	)

overrideprotectedvirtual

Definition at line 143 of file PyAthenaAud.cxx.

 {
   py_after (evt, comp->name(), sc);
 }

◆ after() [3/4]

void PyAthena::Aud::after	(	StandardEventType	evt,
		const std::string &	comp,
		const StatusCode &	sc
	)

overrideprotectedvirtual

Definition at line 137 of file PyAthenaAud.cxx.

 {
   py_after (evt, comp, sc);
 }

◆ after() [4/4]

void PyAthena::Aud::after	(	StandardEventType	evt,
		INamedInterface *	comp,
		const StatusCode &	sc
	)

overrideprotectedvirtual

Definition at line 131 of file PyAthenaAud.cxx.

 {
   py_after (evt, comp->name(), sc);
 }

◆ afterExecute()

void PyAthena::Aud::afterExecute	(	INamedInterface *	comp,
		const StatusCode &	sc
	)

overrideprotectedvirtual

Definition at line 187 of file PyAthenaAud.cxx.

 {
   py_after (IAuditor::Execute, comp->name(), sc);
 }

◆ afterFinalize()

void PyAthena::Aud::afterFinalize ( INamedInterface * comp )

overrideprotectedvirtual

Definition at line 199 of file PyAthenaAud.cxx.

 {
   py_after (IAuditor::Finalize, comp->name(), StatusCode::SUCCESS);
 }

◆ afterInitialize()

void PyAthena::Aud::afterInitialize ( INamedInterface * comp )

overrideprotectedvirtual

Definition at line 163 of file PyAthenaAud.cxx.

 {
   py_after (IAuditor::Initialize, comp->name(), StatusCode::SUCCESS);
 }

◆ afterReinitialize()

void PyAthena::Aud::afterReinitialize ( INamedInterface * comp )

overrideprotectedvirtual

Definition at line 175 of file PyAthenaAud.cxx.

 {
   py_after (IAuditor::ReInitialize, comp->name(), StatusCode::SUCCESS);
 }

◆ before() [1/4]

void PyAthena::Aud::before	(	CustomEventTypeRef	evt,
		const std::string &	comp
	)

overrideprotectedvirtual

Definition at line 125 of file PyAthenaAud.cxx.

 {
   py_before (evt, comp);
 }

◆ before() [2/4]

void PyAthena::Aud::before	(	CustomEventTypeRef	evt,
		INamedInterface *	comp
	)

overrideprotectedvirtual

Definition at line 119 of file PyAthenaAud.cxx.

 {
   py_before (evt, comp->name());
 }

◆ before() [3/4]

void PyAthena::Aud::before	(	StandardEventType	evt,
		const std::string &	comp
	)

overrideprotectedvirtual

Definition at line 113 of file PyAthenaAud.cxx.

 {
   py_before (evt, comp);
 }

◆ before() [4/4]

void PyAthena::Aud::before	(	StandardEventType	evt,
		INamedInterface *	comp
	)

overrideprotectedvirtual

Auditor interface

Definition at line 107 of file PyAthenaAud.cxx.

 {
   py_before (evt, comp->name());
 }

◆ beforeExecute()

void PyAthena::Aud::beforeExecute ( INamedInterface * comp )

overrideprotectedvirtual

Definition at line 181 of file PyAthenaAud.cxx.

 {
   py_before (IAuditor::Execute, comp->name());
 }

◆ beforeFinalize()

void PyAthena::Aud::beforeFinalize ( INamedInterface * comp )

overrideprotectedvirtual

Definition at line 193 of file PyAthenaAud.cxx.

 {
   py_before (IAuditor::Finalize, comp->name());
 }

◆ beforeInitialize()

void PyAthena::Aud::beforeInitialize ( INamedInterface * comp )

overrideprotectedvirtual

Definition at line 157 of file PyAthenaAud.cxx.

 {
   py_before (IAuditor::Initialize, comp->name());
 }

◆ beforeReinitialize()

void PyAthena::Aud::beforeReinitialize ( INamedInterface * comp )

overrideprotectedvirtual

Definition at line 169 of file PyAthenaAud.cxx.

 {
   py_before (IAuditor::ReInitialize, comp->name());
 }

◆ DeclareInterfaceID()

IPyComponent::DeclareInterfaceID	(	IPyComponent	,
		1	,
		0
	)

inherited

◆ finalize()

StatusCode PyAthena::Aud::finalize ( )

overridevirtual

Definition at line 86 of file PyAthenaAud.cxx.

 {
   return PyAthena::callPyMethod( m_self, "sysFinalize" );
 }

◆ initialize()

StatusCode PyAthena::Aud::initialize ( )

overridevirtual

Gaudi Aud Implementation.

Definition at line 60 of file PyAthenaAud.cxx.

 {
   return PyAthena::callPyMethod( m_self, "sysInitialize" );
 }

◆ py_after() [1/2]

void PyAthena::Aud::py_after	(	IAuditor::CustomEventTypeRef	evt,
		const std::string &	component,
		const StatusCode &	sc
	)

virtual

Audit the end of a custom "event".

Definition at line 246 of file PyAthenaAud.cxx.

 {
   return PyAthena::pyAudit (m_self, 
                 "after", evt.c_str(), component.c_str(), sc);
 }

◆ py_after() [2/2]

void PyAthena::Aud::py_after	(	IAuditor::StandardEventType	evt,
		const std::string &	component,
		const StatusCode &	sc
	)

virtual

Audit the end of a standard "event".

Definition at line 228 of file PyAthenaAud.cxx.

 {
   const char* evtname = 0;
   switch (evt) {
   case Initialize:   evtname = "initialize";   break;
   case ReInitialize: evtname = "reinitialize"; break;
   case Execute:      evtname = "execute";      break;
   case Finalize:     evtname = "finalize";     break;
   case Start:        evtname = "start";        break;
   case Stop:         evtname = "stop";         break;
   case ReStart:      evtname = "restart";      break;
   }
   return PyAthena::pyAudit (m_self, "after", evtname, component.c_str(), sc);
 }

◆ py_before() [1/2]

void PyAthena::Aud::py_before	(	IAuditor::CustomEventTypeRef	evt,
		const std::string &	component
	)

virtual

Audit the start of a custom "event".

Definition at line 222 of file PyAthenaAud.cxx.

 {
   return PyAthena::pyAudit (m_self, "before", evt.c_str(), component.c_str());
 }

◆ py_before() [2/2]

void PyAthena::Aud::py_before	(	IAuditor::StandardEventType	evt,
		const std::string &	component
	)

virtual

Audit the start of a standard "event".

Definition at line 206 of file PyAthenaAud.cxx.

 {
   const char* evtname = 0;
   switch (evt) {
   case Initialize:   evtname = "initialize";   break;
   case ReInitialize: evtname = "reinitialize"; break;
   case Execute:      evtname = "execute";      break;
   case Finalize:     evtname = "finalize";     break;
   case Start:        evtname = "start";        break;
   case Stop:         evtname = "stop";         break;
   case ReStart:      evtname = "restart";      break;
   }
   return PyAthena::pyAudit (m_self, "before", evtname, component.c_str());
 }

◆ self()

virtual PyObject* PyAthena::Aud::self ( )

inlineoverridevirtual

return associated python object.

BORROWED reference.

Implements IPyComponent.

Definition at line 76 of file PyAthenaAud.h.

76 { return m_self; }

◆ setPyAttr()

bool PyAthena::Aud::setPyAttr ( PyObject * pyobj )

overrideprotectedvirtual

attach the C++ component to its python cousin

Implements IPyComponent.

Definition at line 260 of file PyAthenaAud.cxx.

 {
   // now we tell the PyObject which C++ object it is the cousin of.
   RootUtils::PyGILStateEnsure ensure;
   PyObject* pyobj = TPython::CPPInstance_FromVoidPtr
     ( (void*)this, this->typeName() );
   if ( !pyobj ) {
     PyErr_Clear();
     // try PyAthena::Aud
     pyobj = TPython::CPPInstance_FromVoidPtr ((void*)this, "PyAthena::Aud");
     MsgStream msg( msgSvc(), name() );
     msg << MSG::INFO
         << "could not dyncast component [" << name() << "] to a python "
         << "object of type [" << this->typeName() << "] (probably a missing "
         << "dictionary)" << endmsg
         << "fallback to [PyAthena::Aud]..."
         << endmsg;
   }
   if ( !pyobj ) {
     PyErr_Clear();
     MsgStream msg( msgSvc(), name() );
     msg << MSG::WARNING << "Could not dyncast component ["
         << name() << "] to a pyobject of type [" 
         << this->typeName() << "]"
         << endmsg;
   } else {
     if ( -1 == PyObject_SetAttrString(o, "_cppHandle", pyobj) ) {
       PyErr_Clear();
       MsgStream msg( msgSvc(), name() );
       msg << MSG::WARNING 
           << "Could not attach C++ handle [" << name() << "] to its python "
           << "cousin !"
           << endmsg;
       if ( -1 == PyObject_SetAttrString(o, "_cppHandle", Py_None) ) {
         PyErr_Clear();
         msg << MSG::WARNING
             << "could not attach a dummy C++ handle [" << name() << "] to its "
             << "python cousin !"
             << endmsg;
       }
     } else {
       return true;
     }
   }
   return false;
 }

◆ sysInitialize()

StatusCode PyAthena::Aud::sysInitialize ( )

overridevirtual

Definition at line 66 of file PyAthenaAud.cxx.

 {
   ServiceHandle<IPyComponentMgr> pyMgr
     ( "PyAthena::PyComponentMgr/PyComponentMgr", name() );
   if ( !pyMgr.retrieve().isSuccess() ) {
     return StatusCode::FAILURE;
   }
  
   // first retrieve our python object cousin...
   m_self = pyMgr->pyObject( this );
  
   if ( m_self == Py_None ) {
     return StatusCode::FAILURE;
   }
  
   // re-route to usual sysInit...
   return ::Auditor::sysInitialize();
 }

◆ typeName()

const char * PyAthena::Aud::typeName ( ) const

overridevirtual

return the std::type_info name of the underlying py-component This is used by concrete implementations to connect a python component to its C++ counter-part

Implements IPyComponent.

Definition at line 96 of file PyAthenaAud.cxx.

 { 
   static const std::string tname = System::typeinfoName(typeid(*this));
   return tname.c_str();
 }

Member Data Documentation

◆ m_self

PyObject* PyAthena::Aud::m_self

protected

Pointer to self (from the python world)

Definition at line 123 of file PyAthenaAud.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Aud() [1/2]

◆ ~Aud()

◆ Aud() [2/2]

Member Function Documentation

◆ after() [1/4]

◆ after() [2/4]

◆ after() [3/4]

◆ after() [4/4]

◆ afterExecute()

◆ afterFinalize()

◆ afterInitialize()

◆ afterReinitialize()

◆ before() [1/4]

◆ before() [2/4]

◆ before() [3/4]

◆ before() [4/4]

◆ beforeExecute()

◆ beforeFinalize()

◆ beforeInitialize()

◆ beforeReinitialize()

◆ DeclareInterfaceID()

◆ finalize()

◆ initialize()

◆ py_after() [1/2]

◆ py_after() [2/2]

◆ py_before() [1/2]

◆ py_before() [2/2]

◆ self()

◆ setPyAttr()

◆ sysInitialize()

◆ typeName()

Member Data Documentation

◆ m_self