The Gaudi Framework  v30r3 (a5ef0a68)
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 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 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 52 of file Helpers.h.

Constructor & Destructor Documentation

GaudiPython::Helper::Helper ( )
inline

Definition at line 56 of file Helpers.h.

56 {}

Member Function Documentation

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

Definition at line 63 of file Helpers.h.

64  {
65  return algmgr->algorithm( name, createIf ).get();
66  }
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 173 of file Helpers.h.

174  {
175 #if PY_VERSION_HEX < 0x02050000
176  const
177 #endif
178  char* buf = nullptr;
179  Py_ssize_t size = ( *( self->ob_type->tp_as_buffer->bf_getcharbuffer ) )( self, 0, &buf );
180  if ( idx < 0 || idx >= size / int( sizeof( T ) ) ) {
181  PyErr_SetString( PyExc_IndexError, "buffer index out of range" );
182  return nullptr;
183  }
184  return toPython( (T*)buf + idx );
185  }
Py_ssize_t
int Py_ssize_t
For compatibility with Python 2.4 and 2.5.
Definition: Helpers.h:35
GaudiPython::Helper::toPython
static PyObject * toPython(T *)
Definition: Helpers.h:161
details::size
constexpr auto size(const C &c) noexcept(noexcept(c.size())) -> decltype(c.size())
Definition: AnyDataWrapper.h:14
template<class T >
static Py_ssize_t GaudiPython::Helper::Array_length ( PyObject *  self)
inlinestaticprivate

Definition at line 150 of file Helpers.h.

151  {
152 #if PY_VERSION_HEX < 0x02050000
153  const
154 #endif
155  char* buf = 0;
156  Py_ssize_t size = ( *( self->ob_type->tp_as_buffer->bf_getcharbuffer ) )( self, 0, &buf );
157  return size / sizeof( T );
158  }
Py_ssize_t
int Py_ssize_t
For compatibility with Python 2.4 and 2.5.
Definition: Helpers.h:35
details::size
constexpr auto size(const C &c) noexcept(noexcept(c.size())) -> decltype(c.size())
Definition: AnyDataWrapper.h:14
static DataObject* GaudiPython::Helper::dataobject ( IDataProviderSvc *  dpsvc,
const std::string &  path 
)
inlinestatic

Definition at line 68 of file Helpers.h.

69  {
70  DataObject* o;
71  return dpsvc->retrieveObject( path, o ).isSuccess() ? o : nullptr;
72  }
StatusCode::isSuccess
bool isSuccess() const
Definition: StatusCode.h:287
IDataProviderSvc::retrieveObject
virtual StatusCode retrieveObject(IRegistry *pDirectory, boost::string_ref path, DataObject *&pObject)=0
Retrieve object identified by its directory entry.
DataObject
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:30
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 }
IDataProviderSvc::findObject
virtual StatusCode findObject(IRegistry *pDirectory, boost::string_ref path, DataObject *&pObject)=0
Find object identified by its directory entry.
StatusCode::isSuccess
bool isSuccess() const
Definition: StatusCode.h:287
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:51
DataObject
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:30
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 }
IDataProviderSvc::findObject
virtual StatusCode findObject(IRegistry *pDirectory, boost::string_ref path, DataObject *&pObject)=0
Find object identified by its directory entry.
StatusCode::isSuccess
bool isSuccess() const
Definition: StatusCode.h:287
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:51
IDataProviderSvc::retrieveObject
virtual StatusCode retrieveObject(IRegistry *pDirectory, boost::string_ref path, DataObject *&pObject)=0
Retrieve object identified by its directory entry.
DataObject
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:30
static IHistogram1D* GaudiPython::Helper::histo1D ( IHistogramSvc *  hsvc,
const std::string &  path 
)
inlinestatic

Definition at line 121 of file Helpers.h.

122  {
123  IHistogram1D* h;
124  return ( hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
125  }
StatusCode::isSuccess
bool isSuccess() const
Definition: StatusCode.h:287
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 126 of file Helpers.h.

127  {
128  IHistogram2D* h;
129  return ( hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
130  }
StatusCode::isSuccess
bool isSuccess() const
Definition: StatusCode.h:287
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 131 of file Helpers.h.

132  {
133  IHistogram3D* h;
134  return ( hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
135  }
StatusCode::isSuccess
bool isSuccess() const
Definition: StatusCode.h:287
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 116 of file Helpers.h.

117  {
118  void* h;
119  return System::loadDynamicLib( name, &h );
120  }
System::loadDynamicLib
GAUDI_API unsigned long loadDynamicLib(const std::string &name, ImageHandle *handle)
Load dynamic link library.
Definition: System.cpp:154
static IProfile1D* GaudiPython::Helper::profile1D ( IHistogramSvc *  hsvc,
const std::string &  path 
)
inlinestatic

Definition at line 136 of file Helpers.h.

137  {
138  IProfile1D* h = 0;
139  return ( hsvc && hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
140  }
StatusCode::isSuccess
bool isSuccess() const
Definition: StatusCode.h:287
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 141 of file Helpers.h.

142  {
143  IProfile2D* h = 0;
144  return ( hsvc && hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
145  }
StatusCode::isSuccess
bool isSuccess() const
Definition: StatusCode.h:287
IHistogramSvc::findObject
virtual StatusCode findObject(const std::string &fullPath, AIDA::IHistogram1D *&h1dObj)=0
static StatusCode GaudiPython::Helper::registerObject ( IDataProviderSvc *  dpsvc,
const std::string &  path,
DataObject *  pObject 
)
inlinestatic

Definition at line 74 of file Helpers.h.

75  {
76  return dpsvc->registerObject( path, pObject );
77  }
IDataProviderSvc::registerObject
virtual StatusCode registerObject(boost::string_ref fullPath, DataObject *pObject)=0
Register object with the data store.
static IService* GaudiPython::Helper::service ( ISvcLocator *  svcloc,
const std::string &  name,
bool  createif = false 
)
inlinestatic

Definition at line 58 of file Helpers.h.

59  {
60  return svcloc->service( name, createif ).get();
61  }
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 223 of file Helpers.h.

224  {
225  return p.fromString( s );
226  }
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 212 of file Helpers.h.

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

Definition at line 217 of file Helpers.h.

218  {
219  return (T*)a;
220  }
template<class T >
template PyObject * GaudiPython::Helper::toArray ( T *  ptr,
Py_ssize_t  size 
)
inlinestatic

Definition at line 189 of file Helpers.h.

190  {
191  static PyTypeObject type = PyBuffer_Type;
192  static PySequenceMethods meth = *( PyBuffer_Type.tp_as_sequence );
193 #if PY_VERSION_HEX < 0x02050000
194  meth.sq_item = (intargfunc)&Array_item<T>;
195  meth.sq_length = (inquiry)&Array_length<T>;
196 #else
197  meth.sq_item = (ssizeargfunc)&Array_item<T>;
198  meth.sq_length = (lenfunc)&Array_length<T>;
199 #endif
200  type.tp_as_sequence = &meth;
201  PyObject* buf = PyBuffer_FromReadWriteMemory( ptr, size * sizeof( T ) );
202  buf->ob_type = &type;
203  Py_INCREF( buf->ob_type );
204  return buf;
205  }
details::size
constexpr auto size(const C &c) noexcept(noexcept(c.size())) -> decltype(c.size())
Definition: AnyDataWrapper.h:14
static PyObject* GaudiPython::Helper::toDoubleArray ( void *  ptr,
Py_ssize_t  size 
)
inlinestatic

Definition at line 209 of file Helpers.h.

209 { return toArray( (double*)ptr, size ); }
GaudiPython::Helper::toArray
static PyObject * toArray(T *ptr, Py_ssize_t size)
Definition: Helpers.h:189
details::size
constexpr auto size(const C &c) noexcept(noexcept(c.size())) -> decltype(c.size())
Definition: AnyDataWrapper.h:14
static PyObject* GaudiPython::Helper::toFloatArray ( void *  ptr,
Py_ssize_t  size 
)
inlinestatic

Definition at line 208 of file Helpers.h.

208 { return toArray( (float*)ptr, size ); }
GaudiPython::Helper::toArray
static PyObject * toArray(T *ptr, Py_ssize_t size)
Definition: Helpers.h:189
details::size
constexpr auto size(const C &c) noexcept(noexcept(c.size())) -> decltype(c.size())
Definition: AnyDataWrapper.h:14
static PyObject* GaudiPython::Helper::toIntArray ( void *  ptr,
Py_ssize_t  size 
)
inlinestatic

Definition at line 206 of file Helpers.h.

206 { return toArray( (int*)ptr, size ); }
GaudiPython::Helper::toArray
static PyObject * toArray(T *ptr, Py_ssize_t size)
Definition: Helpers.h:189
details::size
constexpr auto size(const C &c) noexcept(noexcept(c.size())) -> decltype(c.size())
Definition: AnyDataWrapper.h:14
static IAlgTool* GaudiPython::Helper::tool ( IToolSvc *  toolsvc,
const std::string &  type,
const std::string &  name,
IInterface *  p,
bool  cif 
)
inlinestatic

Definition at line 110 of file Helpers.h.

112  {
113  IAlgTool* o;
114  return toolsvc->retrieve( type, name, IAlgTool::interfaceID(), o, p, cif ).isSuccess() ? o : nullptr;
115  }
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
Definition: StatusCode.h:287
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 161 of file Helpers.h.

162  {
163  return 0;
164  }
static PyObject* GaudiPython::Helper::toPython ( int *  o)
inlinestaticprivate

Definition at line 165 of file Helpers.h.

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

Definition at line 166 of file Helpers.h.

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

Definition at line 167 of file Helpers.h.

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

Definition at line 168 of file Helpers.h.

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

Definition at line 169 of file Helpers.h.

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

Definition at line 170 of file Helpers.h.

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

Definition at line 207 of file Helpers.h.

207 { return toArray( (short*)ptr, size ); }
GaudiPython::Helper::toArray
static PyObject * toArray(T *ptr, Py_ssize_t size)
Definition: Helpers.h:189
details::size
constexpr auto size(const C &c) noexcept(noexcept(c.size())) -> decltype(c.size())
Definition: AnyDataWrapper.h:14
static StatusCode GaudiPython::Helper::unregisterObject ( IDataProviderSvc *  dpsvc,
const std::string &  path 
)
inlinestatic

Definition at line 79 of file Helpers.h.

80  {
81  return dpsvc->unregisterObject( path );
82  }
IDataProviderSvc::unregisterObject
virtual StatusCode unregisterObject(boost::string_ref fullPath)=0
Unregister object from the data store.
The documentation for this struct was generated from the following files: