| The Gaudi Framework v30r0 (c919700c)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

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 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`
| ) |  |
| inline static

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
| ) |  |
| inline static private

Definition at line 175 of file Helpers.h.

176 {
177 #if PY_VERSION_HEX < 0x02050000
178 const
179 #endif
180 char* buf = nullptr;
181 Py_ssize_t size = ( *( self->ob_type->tp_as_buffer->bf_getcharbuffer ) )( self, 0, &buf );
182 if ( idx < 0 || idx >= size / int( sizeof( T ) ) ) {
183 PyErr_SetString( PyExc_IndexError, "buffer index out of range" );
184 return nullptr;
185 }
186 return toPython( (T*)buf + idx );
187 }
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:163
template<class T >

static Py_ssize_t GaudiPython::Helper::Array_length | ( | PyObject * | self | ) |
| inline static private

Definition at line 152 of file Helpers.h.

153 {
154 #if PY_VERSION_HEX < 0x02050000
155 const
156 #endif
157 char* buf = 0;
158 Py_ssize_t size = ( *( self->ob_type->tp_as_buffer->bf_getcharbuffer ) )( self, 0, &buf );
159 return size / sizeof( T );
160 }
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
| ) |  |
| inline static

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:50
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
  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 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
Test for a status code of SUCCESS.
Definition: StatusCode.h:50
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
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
  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 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
Test for a status code of SUCCESS.
Definition: StatusCode.h:50
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
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
| ) |  |
| inline static

Definition at line 123 of file Helpers.h.

124 {
125 IHistogram1D* 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:50
IHistogramSvc::findObject
virtual StatusCode findObject(const std::string &fullPath, AIDA::IHistogram1D *&h1dObj)=0

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

Definition at line 128 of file Helpers.h.

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

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

Definition at line 133 of file Helpers.h.

134 {
135 IHistogram3D* h;
136 return ( hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
137 }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:50
IHistogramSvc::findObject
virtual StatusCode findObject(const std::string &fullPath, AIDA::IHistogram1D *&h1dObj)=0

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

Definition at line 118 of file Helpers.h.

119 {
120 void* h;
121 return System::loadDynamicLib( name, &h );
122 }
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
| ) |  |
| inline static

Definition at line 138 of file Helpers.h.

139 {
140 IProfile1D* h = 0;
141 return ( hsvc && hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
142 }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:50
IHistogramSvc::findObject
virtual StatusCode findObject(const std::string &fullPath, AIDA::IHistogram1D *&h1dObj)=0

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

Definition at line 143 of file Helpers.h.

144 {
145 IProfile2D* h = 0;
146 return ( hsvc && hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
147 }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:50
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
| ) |  |
| inline static

Definition at line 76 of file Helpers.h.

77 {
78 return dpsvc->registerObject( path, pObject );
79 }
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`
| ) |  |
| inline static

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
| ) |  |
| inline static

Definition at line 225 of file Helpers.h.

226 {
227 return p.fromString( s );
228 }
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 | ) |
| inline static

Definition at line 214 of file Helpers.h.

215 {
216 return v.data();
217 }
std::vector::data
T data(T...args)
template<class T >

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

Definition at line 219 of file Helpers.h.

220 {
221 return (T*)a;
222 }
template<class T >

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

Definition at line 191 of file Helpers.h.

192 {
193 static PyTypeObject type = PyBuffer_Type;
194 static PySequenceMethods meth = *( PyBuffer_Type.tp_as_sequence );
195 #if PY_VERSION_HEX < 0x02050000
196 meth.sq_item = (intargfunc)&Array_item<T>;
197 meth.sq_length = (inquiry)&Array_length<T>;
198 #else
199 meth.sq_item = (ssizeargfunc)&Array_item<T>;
200 meth.sq_length = (lenfunc)&Array_length<T>;
201 #endif
202 type.tp_as_sequence = &meth;
203 PyObject* buf = PyBuffer_FromReadWriteMemory( ptr, size * sizeof( T ) );
204 buf->ob_type = &type;
205 Py_INCREF( buf->ob_type );
206 return buf;
207 }
gaudirun.type
type
Definition: gaudirun.py:133

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

Definition at line 211 of file Helpers.h.

211 { return toArray( (double*)ptr, size ); }
GaudiPython::Helper::toArray
static PyObject * toArray(T *ptr, Py_ssize_t size)
Definition: Helpers.h:191

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

Definition at line 210 of file Helpers.h.

210 { return toArray( (float*)ptr, size ); }
GaudiPython::Helper::toArray
static PyObject * toArray(T *ptr, Py_ssize_t size)
Definition: Helpers.h:191

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

Definition at line 208 of file Helpers.h.

208 { return toArray( (int*)ptr, size ); }
GaudiPython::Helper::toArray
static PyObject * toArray(T *ptr, Py_ssize_t size)
Definition: Helpers.h:191

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

Definition at line 112 of file Helpers.h.

114 {
115 IAlgTool* o;
116 return toolsvc->retrieve( type, name, IAlgTool::interfaceID(), o, p, cif ).isSuccess() ? o : nullptr;
117 }
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:50
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 * |  | ) |
| inline static private

Definition at line 163 of file Helpers.h.

164 {
165 return 0;
166 }

static PyObject* GaudiPython::Helper::toPython | ( | int * | o | ) |
| inline static private

Definition at line 167 of file Helpers.h.

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

static PyObject* GaudiPython::Helper::toPython | ( | short * | o | ) |
| inline static private

Definition at line 168 of file Helpers.h.

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

static PyObject* GaudiPython::Helper::toPython | ( | char * | o | ) |
| inline static private

Definition at line 169 of file Helpers.h.

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

static PyObject* GaudiPython::Helper::toPython | ( | long * | o | ) |
| inline static private

Definition at line 170 of file Helpers.h.

170 { return PyInt_FromLong( *o ); }

static PyObject* GaudiPython::Helper::toPython | ( | float * | o | ) |
| inline static private

Definition at line 171 of file Helpers.h.

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

static PyObject* GaudiPython::Helper::toPython | ( | double * | o | ) |
| inline static private

Definition at line 172 of file Helpers.h.

172 { return PyFloat_FromDouble( *o ); }

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

Definition at line 209 of file Helpers.h.

209 { return toArray( (short*)ptr, size ); }
GaudiPython::Helper::toArray
static PyObject * toArray(T *ptr, Py_ssize_t size)
Definition: Helpers.h:191

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

Definition at line 81 of file Helpers.h.

82 {
83 return dpsvc->unregisterObject( path );
84 }
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:

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