All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 (Property &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 47 of file Helpers.h.

Constructor & Destructor Documentation

GaudiPython::Helper::Helper ( )
inline

Definition at line 51 of file Helpers.h.

51 {}

Member Function Documentation

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

Definition at line 58 of file Helpers.h.

61  {
62  return algmgr->algorithm(name, createIf).get();
63  }
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:62
template<class T >
static PyObject* GaudiPython::Helper::Array_item ( PyObject *  self,
Py_ssize_t  idx 
)
inlinestaticprivate

Definition at line 168 of file Helpers.h.

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

Definition at line 150 of file Helpers.h.

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

Definition at line 65 of file Helpers.h.

67  {
68  DataObject* o;
69  if ( dpsvc->retrieveObject(path,o).isSuccess() ) return o;
70  else return 0;
71  }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:62
Gaudi::Utils::Histos::path
GAUDI_API std::string path(const AIDA::IBaseHistogram *aida)
get the path in THS for AIDA histogram
Definition: HistoTableFormat.cpp:185
DataObject
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:31
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 42 of file Helpers.cpp.

44 {
45  DataObject* o = 0 ;
46  if ( 0 == dpsvc ) { return 0 ; } // RETURN
47  StatusCode sc = dpsvc -> findObject ( path , o ) ; // NB!
48  if ( sc.isFailure() ) { return 0 ; } // RETURN
49  return o ; // RETURN
50 }
merge_files.sc
int sc
Definition: merge_files.py:153
StatusCode::isFailure
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:72
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:30
Gaudi::Utils::Histos::path
GAUDI_API std::string path(const AIDA::IBaseHistogram *aida)
get the path in THS for AIDA histogram
Definition: HistoTableFormat.cpp:185
DataObject
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:31
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 134 of file Helpers.cpp.

138 {
139  if ( 0 == dpsvc ) { return 0 ; } // RETURN 0
140  // create the sentry:
141  Disabler sentry ( dpsvc , disable ) ;
142  //
143  DataObject * result = 0 ;
144  //
145  StatusCode sc =
146  retrieve ?
147  dpsvc -> retrieveObject ( path , result ) :
148  dpsvc -> findObject ( path , result ) ;
149  //
150  if ( sc.isFailure() ) { return 0 ; } // RETURN
151  //
152  return result ; // RETURN
153 }
merge_files.sc
int sc
Definition: merge_files.py:153
StatusCode::isFailure
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:72
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:30
Gaudi::Utils::Histos::path
GAUDI_API std::string path(const AIDA::IBaseHistogram *aida)
get the path in THS for AIDA histogram
Definition: HistoTableFormat.cpp:185
DataObject
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:31
static IHistogram1D* GaudiPython::Helper::histo1D ( IHistogramSvc *  hsvc,
const std::string &  path 
)
inlinestatic

Definition at line 113 of file Helpers.h.

113  {
114  IHistogram1D* h;
115  if ( hsvc->findObject(path, h ).isSuccess() ) return h;
116  else return 0;
117  }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:62
Gaudi::Utils::Histos::path
GAUDI_API std::string path(const AIDA::IBaseHistogram *aida)
get the path in THS for AIDA histogram
Definition: HistoTableFormat.cpp:185
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.

118  {
119  IHistogram2D* h;
120  if ( hsvc->findObject(path, h ).isSuccess() ) return h;
121  else return 0;
122  }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:62
Gaudi::Utils::Histos::path
GAUDI_API std::string path(const AIDA::IBaseHistogram *aida)
get the path in THS for AIDA histogram
Definition: HistoTableFormat.cpp:185
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.

123  {
124  IHistogram3D* h;
125  if ( hsvc->findObject(path, h ).isSuccess() ) return h;
126  else return 0;
127  }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:62
Gaudi::Utils::Histos::path
GAUDI_API std::string path(const AIDA::IBaseHistogram *aida)
get the path in THS for AIDA histogram
Definition: HistoTableFormat.cpp:185
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 109 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:123
static IProfile1D* GaudiPython::Helper::profile1D ( IHistogramSvc *  hsvc,
const std::string &  path 
)
inlinestatic

Definition at line 130 of file Helpers.h.

132  {
133  IProfile1D* h = 0 ;
134  if ( 0 != hsvc && hsvc->findObject ( path , h ).isSuccess() ) { return h ; }
135  return 0 ;
136  }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:62
Gaudi::Utils::Histos::path
GAUDI_API std::string path(const AIDA::IBaseHistogram *aida)
get the path in THS for AIDA histogram
Definition: HistoTableFormat.cpp:185
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 139 of file Helpers.h.

141  {
142  IProfile2D* h = 0 ;
143  if ( 0 != hsvc && hsvc->findObject ( path , h ).isSuccess() ) { return h ; }
144  return 0 ;
145  }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:62
Gaudi::Utils::Histos::path
GAUDI_API std::string path(const AIDA::IBaseHistogram *aida)
get the path in THS for AIDA histogram
Definition: HistoTableFormat.cpp:185
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 53 of file Helpers.h.

53  {
54  return svcloc->service(name, createif).get();
55  }
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:82
static StatusCode GaudiPython::Helper::setPropertyFromString ( Property &  p,
const std::string &  s 
)
inlinestatic

Definition at line 214 of file Helpers.h.

214  {
215  return p.fromString(s);
216  }
gaudirun.s
string s
Definition: gaudirun.py:210
Property::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 205 of file Helpers.h.

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

Definition at line 209 of file Helpers.h.

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

Definition at line 183 of file Helpers.h.

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

Definition at line 202 of file Helpers.h.

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

Definition at line 201 of file Helpers.h.

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

Definition at line 199 of file Helpers.h.

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

Definition at line 104 of file Helpers.h.

104  {
105  IAlgTool* o;
106  if ( toolsvc->retrieve(type, name, IAlgTool::interfaceID(), o, p, cif).isSuccess() ) return o;
107  else return 0;
108  }
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:62
gaudirun.type
string type
Definition: gaudirun.py:126
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:171
template<class T >
static PyObject* GaudiPython::Helper::toPython ( T *  )
inlinestaticprivate

Definition at line 159 of file Helpers.h.

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

Definition at line 160 of file Helpers.h.

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

Definition at line 161 of file Helpers.h.

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

Definition at line 162 of file Helpers.h.

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

Definition at line 163 of file Helpers.h.

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

Definition at line 164 of file Helpers.h.

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

Definition at line 165 of file Helpers.h.

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

Definition at line 200 of file Helpers.h.

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