The Gaudi Framework  v29r0 (ff2e7097)
Public Member Functions | Static Public Member Functions | Static Private Member Functions | List of all members
GaudiPython::Helper Struct Reference

#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 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 More...
 
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 More...
 
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 StatusCode setPropertyFromString (Gaudi::Details::PropertyBase &p, const std::string &s)
 

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 54 of file Helpers.h.

Constructor & Destructor Documentation

GaudiPython::Helper::Helper ( )
inline

Definition at line 58 of file Helpers.h.

58 {}

Member Function Documentation

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

Definition at line 65 of file Helpers.h.

66  {
67  return algmgr->algorithm( name, createIf ).get();
68  }
IAlgManager::algorithm
virtual SmartIF< IAlgorithm > & algorithm(const Gaudi::Utils::TypeNameString &typeName, const bool createIf=true)=0
Returns a smart pointer to a service.
SmartIF::get
TYPE * get() const
Get interface pointer.
Definition: SmartIF.h:82
template<class T >
static PyObject* GaudiPython::Helper::Array_item ( PyObject *  self,
Py_ssize_t  idx 
)
inlinestaticprivate

Definition at line 165 of file Helpers.h.

166  {
167 #if PY_VERSION_HEX < 0x02050000
168  const
169 #endif
170  char* buf = nullptr;
171  Py_ssize_t size = ( *( self->ob_type->tp_as_buffer->bf_getcharbuffer ) )( self, 0, &buf );
172  if ( idx < 0 || idx >= size / int( sizeof( T ) ) ) {
173  PyErr_SetString( PyExc_IndexError, "buffer index out of range" );
174  return nullptr;
175  }
176  return toPython( (T*)buf + idx );
177  }
Py_ssize_t
int Py_ssize_t
For compatibility with Python 2.4 and 2.5.
Definition: Helpers.h:37
GaudiPython::Helper::toPython
static PyObject * toPython(T *)
Definition: Helpers.h:153
template<class T >
static Py_ssize_t GaudiPython::Helper::Array_length ( PyObject *  self)
inlinestaticprivate

Definition at line 142 of file Helpers.h.

143  {
144 #if PY_VERSION_HEX < 0x02050000
145  const
146 #endif
147  char* buf = 0;
148  Py_ssize_t size = ( *( self->ob_type->tp_as_buffer->bf_getcharbuffer ) )( self, 0, &buf );
149  return size / sizeof( T );
150  }
Py_ssize_t
int Py_ssize_t
For compatibility with Python 2.4 and 2.5.
Definition: Helpers.h:37
static DataObject* GaudiPython::Helper::dataobject ( IDataProviderSvc *  dpsvc,
const std::string &  path 
)
inlinestatic

Definition at line 70 of file Helpers.h.

71  {
72  DataObject* o;
73  return dpsvc->retrieveObject( path, o ).isSuccess() ? o : nullptr;
74  }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:75
DataObject
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:29
IDataProviderSvc::retrieveObject
virtual StatusCode retrieveObject(IRegistry *pDirectory, const std::string &path, DataObject *&pObject)=0
Retrieve object identified by its directory entry.
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
paththe 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 41 of file Helpers.cpp.

42 {
43  DataObject* o = nullptr;
44  if ( !dpsvc ) {
45  return nullptr;
46  } // RETURN
47  StatusCode sc = dpsvc->findObject( path, o ); // NB!
48  return sc.isSuccess() ? o : nullptr; // RETURN
49 }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:75
IDataProviderSvc::findObject
virtual StatusCode findObject(IRegistry *pDirectory, const std::string &path, DataObject *&pObject)=0
Find object identified by its directory entry.
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:28
DataObject
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:29
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
paththe 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 116 of file Helpers.cpp.

118 {
119  if ( !dpsvc ) {
120  return nullptr;
121  } // RETURN 0
122  // create the sentry:
123  Disabler sentry( dpsvc, disable );
124  //
125  DataObject* result = nullptr;
126  //
127  StatusCode sc = retrieve ? dpsvc->retrieveObject( path, result ) : dpsvc->findObject( path, result );
128  //
129  return sc.isSuccess() ? result : nullptr;
130 }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:75
IDataProviderSvc::findObject
virtual StatusCode findObject(IRegistry *pDirectory, const std::string &path, DataObject *&pObject)=0
Find object identified by its directory entry.
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:28
DataObject
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:29
IDataProviderSvc::retrieveObject
virtual StatusCode retrieveObject(IRegistry *pDirectory, const std::string &path, DataObject *&pObject)=0
Retrieve object identified by its directory entry.
static IHistogram1D* GaudiPython::Helper::histo1D ( IHistogramSvc *  hsvc,
const std::string &  path 
)
inlinestatic

Definition at line 113 of file Helpers.h.

114  {
115  IHistogram1D* h;
116  return ( hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
117  }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:75
IHistogramSvc::findObject
virtual StatusCode findObject(const std::string &fullPath, AIDA::IHistogram1D *&h1dObj)=0
static IHistogram2D* GaudiPython::Helper::histo2D ( IHistogramSvc *  hsvc,
const std::string &  path 
)
inlinestatic

Definition at line 118 of file Helpers.h.

119  {
120  IHistogram2D* h;
121  return ( hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
122  }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:75
IHistogramSvc::findObject
virtual StatusCode findObject(const std::string &fullPath, AIDA::IHistogram1D *&h1dObj)=0
static IHistogram3D* GaudiPython::Helper::histo3D ( IHistogramSvc *  hsvc,
const std::string &  path 
)
inlinestatic

Definition at line 123 of file Helpers.h.

124  {
125  IHistogram3D* h;
126  return ( hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
127  }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:75
IHistogramSvc::findObject
virtual StatusCode findObject(const std::string &fullPath, AIDA::IHistogram1D *&h1dObj)=0
static long GaudiPython::Helper::loadDynamicLib ( const std::string &  name)
inlinestatic

Definition at line 108 of file Helpers.h.

109  {
110  void* h;
111  return System::loadDynamicLib( name, &h );
112  }
System::loadDynamicLib
GAUDI_API unsigned long loadDynamicLib(const std::string &name, ImageHandle *handle)
Load dynamic link library.
Definition: System.cpp:147
static IProfile1D* GaudiPython::Helper::profile1D ( IHistogramSvc *  hsvc,
const std::string &  path 
)
inlinestatic

Definition at line 128 of file Helpers.h.

129  {
130  IProfile1D* h = 0;
131  return ( hsvc && hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
132  }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:75
IHistogramSvc::findObject
virtual StatusCode findObject(const std::string &fullPath, AIDA::IHistogram1D *&h1dObj)=0
static IProfile2D* GaudiPython::Helper::profile2D ( IHistogramSvc *  hsvc,
const std::string &  path 
)
inlinestatic

Definition at line 133 of file Helpers.h.

134  {
135  IProfile2D* h = 0;
136  return ( hsvc && hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
137  }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:75
IHistogramSvc::findObject
virtual StatusCode findObject(const std::string &fullPath, AIDA::IHistogram1D *&h1dObj)=0
static IService* GaudiPython::Helper::service ( ISvcLocator *  svcloc,
const std::string &  name,
bool  createif = false 
)
inlinestatic

Definition at line 60 of file Helpers.h.

61  {
62  return svcloc->service( name, createif ).get();
63  }
ISvcLocator::service
StatusCode service(const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
Templated method to access a service by name.
Definition: ISvcLocator.h:79
static StatusCode GaudiPython::Helper::setPropertyFromString ( Gaudi::Details::PropertyBase &  p,
const std::string &  s 
)
inlinestatic

Definition at line 215 of file Helpers.h.

216  {
217  return p.fromString( s );
218  }
Gaudi::Details::PropertyBase::fromString
virtual StatusCode fromString(const std::string &value)=0
string -> value
template<class T >
static T* GaudiPython::Helper::toAddress ( std::vector< T > &  v)
inlinestatic

Definition at line 204 of file Helpers.h.

205  {
206  return v.data();
207  }
std::vector::data
T data(T...args)
template<class T >
static T* GaudiPython::Helper::toAddress ( void *  a)
inlinestatic

Definition at line 209 of file Helpers.h.

210  {
211  return (T*)a;
212  }
template<class T >
template PyObject * GaudiPython::Helper::toArray ( T *  ptr,
Py_ssize_t  size 
)
inlinestatic

Definition at line 181 of file Helpers.h.

182  {
183  static PyTypeObject type = PyBuffer_Type;
184  static PySequenceMethods meth = *( PyBuffer_Type.tp_as_sequence );
185 #if PY_VERSION_HEX < 0x02050000
186  meth.sq_item = (intargfunc)&Array_item<T>;
187  meth.sq_length = (inquiry)&Array_length<T>;
188 #else
189  meth.sq_item = (ssizeargfunc)&Array_item<T>;
190  meth.sq_length = (lenfunc)&Array_length<T>;
191 #endif
192  type.tp_as_sequence = &meth;
193  PyObject* buf = PyBuffer_FromReadWriteMemory( ptr, size * sizeof( T ) );
194  buf->ob_type = &type;
195  Py_INCREF( buf->ob_type );
196  return buf;
197  }
static PyObject* GaudiPython::Helper::toDoubleArray ( void *  ptr,
Py_ssize_t  size 
)
inlinestatic

Definition at line 201 of file Helpers.h.

201 { return toArray( (double*)ptr, size ); }
GaudiPython::Helper::toArray
static PyObject * toArray(T *ptr, Py_ssize_t size)
Definition: Helpers.h:181
static PyObject* GaudiPython::Helper::toFloatArray ( void *  ptr,
Py_ssize_t  size 
)
inlinestatic

Definition at line 200 of file Helpers.h.

200 { return toArray( (float*)ptr, size ); }
GaudiPython::Helper::toArray
static PyObject * toArray(T *ptr, Py_ssize_t size)
Definition: Helpers.h:181
static PyObject* GaudiPython::Helper::toIntArray ( void *  ptr,
Py_ssize_t  size 
)
inlinestatic

Definition at line 198 of file Helpers.h.

198 { return toArray( (int*)ptr, size ); }
GaudiPython::Helper::toArray
static PyObject * toArray(T *ptr, Py_ssize_t size)
Definition: Helpers.h:181
static IAlgTool* GaudiPython::Helper::tool ( IToolSvc *  toolsvc,
const std::string &  type,
const std::string &  name,
IInterface *  p,
bool  cif 
)
inlinestatic

Definition at line 102 of file Helpers.h.

104  {
105  IAlgTool* o;
106  return toolsvc->retrieve( type, name, IAlgTool::interfaceID(), o, p, cif ).isSuccess() ? o : nullptr;
107  }
IToolSvc::retrieve
virtual StatusCode retrieve(const std::string &type, const InterfaceID &iid, IAlgTool *&tool, const IInterface *parent=0, bool createIf=true)=0
Retrieve tool with tool dependent part of the name automatically assigned.
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:75
IAlgTool
The interface implemented by the AlgTool base class.
Definition: IAlgTool.h:23
IInterface::interfaceID
static const InterfaceID & interfaceID()
Return an instance of InterfaceID identifying the interface.
Definition: IInterface.h:287
template<class T >
static PyObject* GaudiPython::Helper::toPython ( T *  )
inlinestaticprivate

Definition at line 153 of file Helpers.h.

154  {
155  return 0;
156  }
static PyObject* GaudiPython::Helper::toPython ( int *  o)
inlinestaticprivate

Definition at line 157 of file Helpers.h.

157 { return PyInt_FromLong( (long)*o ); }
static PyObject* GaudiPython::Helper::toPython ( short *  o)
inlinestaticprivate

Definition at line 158 of file Helpers.h.

158 { return PyInt_FromLong( (long)*o ); }
static PyObject* GaudiPython::Helper::toPython ( char *  o)
inlinestaticprivate

Definition at line 159 of file Helpers.h.

159 { return PyInt_FromLong( (long)*o ); }
static PyObject* GaudiPython::Helper::toPython ( long *  o)
inlinestaticprivate

Definition at line 160 of file Helpers.h.

160 { return PyInt_FromLong( *o ); }
static PyObject* GaudiPython::Helper::toPython ( float *  o)
inlinestaticprivate

Definition at line 161 of file Helpers.h.

161 { return PyFloat_FromDouble( (double)*o ); }
static PyObject* GaudiPython::Helper::toPython ( double *  o)
inlinestaticprivate

Definition at line 162 of file Helpers.h.

162 { return PyFloat_FromDouble( *o ); }
static PyObject* GaudiPython::Helper::toShortArray ( void *  ptr,
Py_ssize_t  size 
)
inlinestatic

Definition at line 199 of file Helpers.h.

199 { return toArray( (short*)ptr, size ); }
GaudiPython::Helper::toArray
static PyObject * toArray(T *ptr, Py_ssize_t size)
Definition: Helpers.h:181
The documentation for this struct was generated from the following files: