#include </builds/gaudi/Gaudi/GaudiPython/include/GaudiPython/Helpers.h>

Public Member Functions
	Helper ()

Static Public Member Functions
static IService *	service (ISvcLocator *svcloc, const std::string &name, bool createif=false)

static IAlgorithm *	algorithm (IAlgManager *algmgr, const std::string &name, const bool createIf=false)

static DataObject *	dataobject (IDataProviderSvc *dpsvc, const std::string &path)

static StatusCode	registerObject (IDataProviderSvc dpsvc, const std::string &path, DataObject pObject)

static StatusCode	unregisterObject (IDataProviderSvc *dpsvc, const std::string &path)

static GAUDI_API DataObject *	findobject (IDataProviderSvc *dpsvc, const std::string &path)
	simple wrapper for IDataProviderSvc::findObject The methdod does NOT trigger the loading the object from tape or Data-On-Demand action

static GAUDI_API DataObject *	getobject (IDataProviderSvc *dpsvc, const std::string &path, const bool retrieve=true, const bool disableDoD=false)
	the generic function to get object from TES

static IAlgTool *	tool (IToolSvc toolsvc, const std::string &type, const std::string &name, IInterface p, bool cif)

static long	loadDynamicLib (const std::string &name)

static IHistogram1D *	histo1D (IHistogramSvc *hsvc, const std::string &path)

static IHistogram2D *	histo2D (IHistogramSvc *hsvc, const std::string &path)

static IHistogram3D *	histo3D (IHistogramSvc *hsvc, const std::string &path)

static IProfile1D *	profile1D (IHistogramSvc *hsvc, const std::string &path)

static IProfile2D *	profile2D (IHistogramSvc *hsvc, const std::string &path)

template<class T>
static PyObject *	toArray (T *ptr, Py_ssize_t size)

static PyObject *	toIntArray (void *ptr, Py_ssize_t size)

static PyObject *	toShortArray (void *ptr, Py_ssize_t size)

static PyObject *	toFloatArray (void *ptr, Py_ssize_t size)

static PyObject *	toDoubleArray (void *ptr, Py_ssize_t size)

template<class T>
static T *	toAddress (std::vector< T > &v)

template<class T>
static T *	toAddress (void *a)

Static Private Member Functions
template<class T>
static Py_ssize_t	Array_length (PyObject *self)

template<class T>
static PyObject *	toPython (T *)

static PyObject *	toPython (int *o)

static PyObject *	toPython (short *o)

static PyObject *	toPython (char *o)

static PyObject *	toPython (long *o)

static PyObject *	toPython (float *o)

static PyObject *	toPython (double *o)

template<class T>
static PyObject *	Array_item (PyObject *self, Py_ssize_t idx)

Detailed Description

Definition at line 68 of file Helpers.h.

Constructor & Destructor Documentation

◆ Helper()

GaudiPython::Helper::Helper ( )

inline

Definition at line 103 of file Helpers.h.

103{}

Member Function Documentation

◆ algorithm()

static IAlgorithm * GaudiPython::Helper::algorithm	(	IAlgManager *	algmgr,
		const std::string &	name,
		const bool	createIf = false )

inlinestatic

Definition at line 109 of file Helpers.h.

                                                                                                            {
      return algmgr->algorithm( name, createIf ).get();
    }

◆ Array_item()

template<class T>

static PyObject * GaudiPython::Helper::Array_item	(	PyObject *	self,
		Py_ssize_t	idx )

inlinestaticprivate

Definition at line 212 of file Helpers.h.

                                                                  {
#if PY_VERSION_HEX < 0x02050000
      const
#endif
          char* buf = nullptr;
#if PY_MAJOR_VERSION >= 3
      Py_buffer bufinfo;
      ( *( self->ob_type->tp_as_buffer->bf_getbuffer ) )( self, &bufinfo, PyBUF_SIMPLE );
      Py_ssize_t size = bufinfo.len;
#else
      Py_ssize_t size = ( *( self->ob_type->tp_as_buffer->bf_getcharbuffer ) )( self, 0, &buf );
#endif
      if ( idx < 0 || idx >= size / int( sizeof( T ) ) ) {
        PyErr_SetString( PyExc_IndexError, "buffer index out of range" );
        return nullptr;
      }
      return toPython( (T*)buf + idx );
    }

◆ Array_length()

template<class T>

static Py_ssize_t GaudiPython::Helper::Array_length ( PyObject * self )

inlinestaticprivate

Definition at line 185 of file Helpers.h.

                                                     {
#if PY_MAJOR_VERSION >= 3
      Py_buffer bufinfo;
      ( *( self->ob_type->tp_as_buffer->bf_getbuffer ) )( self, &bufinfo, PyBUF_SIMPLE );
      Py_ssize_t size = bufinfo.len;
#else
#  if PY_VERSION_HEX < 0x02050000
      const
#  endif
          char*  buf  = 0;
      Py_ssize_t size = ( *( self->ob_type->tp_as_buffer->bf_getcharbuffer ) )( self, 0, &buf );
#endif
      return size / sizeof( T );
    }

◆ dataobject()

static DataObject * GaudiPython::Helper::dataobject	(	IDataProviderSvc *	dpsvc,
		const std::string &	path )

inlinestatic

Definition at line 113 of file Helpers.h.

                                                                                    {
      DataObject* o;
      return dpsvc->retrieveObject( path, o ).isSuccess() ? o : nullptr;
    }

◆ findobject()

DataObject * GaudiPython::Helper::findobject	(	IDataProviderSvc *	dpsvc,
		const std::string &	path )

static

simple wrapper for IDataProviderSvc::findObject The methdod does NOT trigger the loading the object from tape or Data-On-Demand action

See also: IDataProviderSvc; IDataProviderSvc::findObject

Parameters

psvc	(INPUT) pointer to Data ProviderService
path	the full path in TES

Returns: the object

Author: Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date: 2009-10-09

Definition at line 51 of file Helpers.cpp.

                                                                                          {
  DataObject* o = nullptr;
  if ( !dpsvc ) { return nullptr; }             // RETURN
  StatusCode sc = dpsvc->findObject( path, o ); // NB!
  return sc.isSuccess() ? o : nullptr;          // RETURN
}

◆ getobject()

DataObject * GaudiPython::Helper::getobject	(	IDataProviderSvc *	dpsvc,
		const std::string &	path,
		const bool	retrieve = true,
		const bool	disableDoD = false )

static

the generic function to get object from TES

See also: IDataProviderSvc; IDataProviderSvc::findObject; IDataProviderSvc::retriveObject

Parameters

psvc	(INPUT) pointer to Data ProviderService
path	the full path in TES
rerieve	(INPUT) retrieve or find object ?
disableDoD	(INPUT) disable 'on-demand-actions' ?

Author: Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date: 2009-10-09

Definition at line 119 of file Helpers.cpp.

                                                                 {
  if ( !dpsvc ) { return nullptr; } // RETURN 0
  // create the sentry:
  Disabler sentry( dpsvc, disable );
  //
  DataObject* result = nullptr;
  //
  StatusCode sc = retrieve ? dpsvc->retrieveObject( path, result ) : dpsvc->findObject( path, result );
  //
  return sc.isSuccess() ? result : nullptr;
}

◆ histo1D()

static IHistogram1D * GaudiPython::Helper::histo1D	(	IHistogramSvc *	hsvc,
		const std::string &	path )

inlinestatic

Definition at line 161 of file Helpers.h.

                                                                               {
      IHistogram1D* h;
      return ( hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
    }

◆ histo2D()

static IHistogram2D * GaudiPython::Helper::histo2D	(	IHistogramSvc *	hsvc,
		const std::string &	path )

inlinestatic

Definition at line 165 of file Helpers.h.

                                                                               {
      IHistogram2D* h;
      return ( hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
    }

◆ histo3D()

static IHistogram3D * GaudiPython::Helper::histo3D	(	IHistogramSvc *	hsvc,
		const std::string &	path )

inlinestatic

Definition at line 169 of file Helpers.h.

                                                                               {
      IHistogram3D* h;
      return ( hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
    }

◆ loadDynamicLib()

static long GaudiPython::Helper::loadDynamicLib ( const std::string & name )

inlinestatic

Definition at line 157 of file Helpers.h.

                                                        {
      void* h;
      return System::loadDynamicLib( name, &h );
    }

◆ profile1D()

static IProfile1D * GaudiPython::Helper::profile1D	(	IHistogramSvc *	hsvc,
		const std::string &	path )

inlinestatic

Definition at line 173 of file Helpers.h.

                                                                               {
      IProfile1D* h = 0;
      return ( hsvc && hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
    }

◆ profile2D()

static IProfile2D * GaudiPython::Helper::profile2D	(	IHistogramSvc *	hsvc,
		const std::string &	path )

inlinestatic

Definition at line 177 of file Helpers.h.

                                                                               {
      IProfile2D* h = 0;
      return ( hsvc && hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
    }

◆ registerObject()

static StatusCode GaudiPython::Helper::registerObject	(	IDataProviderSvc *	dpsvc,
		const std::string &	path,
		DataObject *	pObject )

inlinestatic

Definition at line 118 of file Helpers.h.

                                                                                                            {
      return dpsvc->registerObject( path, pObject );
    }

◆ service()

static IService * GaudiPython::Helper::service	(	ISvcLocator *	svcloc,
		const std::string &	name,
		bool	createif = false )

inlinestatic

Definition at line 105 of file Helpers.h.

                                                                                                  {
      return svcloc->service( name, createif ).get();
    }

◆ toAddress() [1/2]

template<class T>

static T * GaudiPython::Helper::toAddress ( std::vector< T > & v )

inlinestatic

Definition at line 255 of file Helpers.h.

                                           {
      return v.data();
    }

◆ toAddress() [2/2]

template<class T>

static T * GaudiPython::Helper::toAddress ( void * a )

inlinestatic

Definition at line 259 of file Helpers.h.

                                   {
      return (T*)a;
    }

◆ toArray()

template<class T>

template PyObject * GaudiPython::Helper::toArray	(	T *	ptr,
		Py_ssize_t	size )

inlinestatic

Definition at line 233 of file Helpers.h.

                                                        {
      static PyTypeObject      type = PyBuffer_Type;
      static PySequenceMethods meth = *( PyBuffer_Type.tp_as_sequence );
#if PY_VERSION_HEX < 0x02050000
      meth.sq_item   = (intargfunc)&Array_item<T>;
      meth.sq_length = (inquiry)&Array_length<T>;
#else
      meth.sq_item    = (ssizeargfunc)&Array_item<T>;
      meth.sq_length  = (lenfunc)&Array_length<T>;
#endif
      type.tp_as_sequence = &meth;
      PyObject* buf       = PyBuffer_FromReadWriteMemory( ptr, size * sizeof( T ) );
      buf->ob_type        = &type;
      Py_INCREF( buf->ob_type );
      return buf;
    }

◆ toDoubleArray()

static PyObject * GaudiPython::Helper::toDoubleArray	(	void *	ptr,
		Py_ssize_t	size )

inlinestatic

Definition at line 252 of file Helpers.h.

252{ return toArray( (double*)ptr, size ); }

GaudiPython::Helper::toArray

static PyObject * toArray(T *ptr, Py_ssize_t size)

Definition Helpers.h:233

◆ toFloatArray()

static PyObject * GaudiPython::Helper::toFloatArray	(	void *	ptr,
		Py_ssize_t	size )

inlinestatic

Definition at line 251 of file Helpers.h.

251{ return toArray( (float*)ptr, size ); }

◆ toIntArray()

static PyObject * GaudiPython::Helper::toIntArray	(	void *	ptr,
		Py_ssize_t	size )

inlinestatic

Definition at line 249 of file Helpers.h.

249{ return toArray( (int*)ptr, size ); }

◆ tool()

static IAlgTool * GaudiPython::Helper::tool	(	IToolSvc *	toolsvc,
		const std::string &	type,
		const std::string &	name,
		IInterface *	p,
		bool	cif )

inlinestatic

Definition at line 152 of file Helpers.h.

                                      {
      IAlgTool* o;
      return toolsvc->retrieve( type, name, IAlgTool::interfaceID(), o, p, cif ).isSuccess() ? o : nullptr;
    }

◆ toPython() [1/7]

static PyObject * GaudiPython::Helper::toPython ( char * o )

inlinestaticprivate

Definition at line 206 of file Helpers.h.

206{ return PyInt_FromLong( (long)*o ); }

◆ toPython() [2/7]

static PyObject * GaudiPython::Helper::toPython ( double * o )

inlinestaticprivate

Definition at line 209 of file Helpers.h.

209{ return PyFloat_FromDouble( *o ); }

◆ toPython() [3/7]

static PyObject * GaudiPython::Helper::toPython ( float * o )

inlinestaticprivate

Definition at line 208 of file Helpers.h.

208{ return PyFloat_FromDouble( (double)*o ); }

◆ toPython() [4/7]

static PyObject * GaudiPython::Helper::toPython ( int * o )

inlinestaticprivate

Definition at line 204 of file Helpers.h.

204{ return PyInt_FromLong( (long)*o ); }

◆ toPython() [5/7]

static PyObject * GaudiPython::Helper::toPython ( long * o )

inlinestaticprivate

Definition at line 207 of file Helpers.h.

207{ return PyInt_FromLong( *o ); }

◆ toPython() [6/7]

static PyObject * GaudiPython::Helper::toPython ( short * o )

inlinestaticprivate

Definition at line 205 of file Helpers.h.

205{ return PyInt_FromLong( (long)*o ); }

◆ toPython() [7/7]

template<class T>

static PyObject * GaudiPython::Helper::toPython ( T * )

inlinestaticprivate

Definition at line 201 of file Helpers.h.

                                      {
      return 0;
    }

◆ toShortArray()

static PyObject * GaudiPython::Helper::toShortArray	(	void *	ptr,
		Py_ssize_t	size )

inlinestatic

Definition at line 250 of file Helpers.h.

250{ return toArray( (short*)ptr, size ); }

◆ unregisterObject()

static StatusCode GaudiPython::Helper::unregisterObject	(	IDataProviderSvc *	dpsvc,
		const std::string &	path )

inlinestatic

Definition at line 122 of file Helpers.h.

                                                                                         {
      return dpsvc->unregisterObject( path );
    }

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

GaudiPython/include/GaudiPython/Helpers.h
GaudiPython/src/Lib/Helpers.cpp

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Helper()

Member Function Documentation

◆ algorithm()

◆ Array_item()

◆ Array_length()

◆ dataobject()

◆ findobject()

◆ getobject()

◆ histo1D()

◆ histo2D()

◆ histo3D()

◆ loadDynamicLib()

◆ profile1D()

◆ profile2D()

◆ registerObject()

◆ service()

◆ toAddress() [1/2]

◆ toAddress() [2/2]

◆ toArray()

◆ toDoubleArray()

◆ toFloatArray()

◆ toIntArray()

◆ tool()

◆ toPython() [1/7]

◆ toPython() [2/7]

◆ toPython() [3/7]

◆ toPython() [4/7]

◆ toPython() [5/7]

◆ toPython() [6/7]

◆ toPython() [7/7]

◆ toShortArray()

◆ unregisterObject()