| The Gaudi Framework v28r2p1 (f1a77ff4)

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

## Constructor & Destructor Documentation

GaudiPython::Helper::Helper | ( |  | ) |
| inline

Definition at line 54 of file Helpers.h.

54 {}

## Member Function Documentation

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

Definition at line 61 of file Helpers.h.

62 {
63 return algmgr->algorithm( name, createIf ).get();
64 }
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:76
template<class T >

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

Definition at line 161 of file Helpers.h.

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

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

Definition at line 138 of file Helpers.h.

139 {
140 #if PY_VERSION_HEX < 0x02050000
141 const
142 #endif
143 char* buf = 0;
144 Py_ssize_t size = ( *( self->ob_type->tp_as_buffer->bf_getcharbuffer ) )( self, 0, &buf );
145 return size / sizeof( T );
146 }
Py_ssize_t
int Py_ssize_t
For compatibility with Python 2.4 and 2.5.
Definition: Helpers.h:33

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

Definition at line 66 of file Helpers.h.

67 {
68 DataObject* o;
69 return dpsvc->retrieveObject( path, o ).isSuccess() ? o : nullptr;
70 }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:74
DataObject
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:30
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
  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 }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:74
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: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 }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:74
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:26
DataObject
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:30
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
| ) |  |
| inline static

Definition at line 109 of file Helpers.h.

110 {
111 IHistogram1D* h;
112 return ( hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
113 }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:74
HiveAlgSequencer.h
h
Definition: HiveAlgSequencer.py:24
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 114 of file Helpers.h.

115 {
116 IHistogram2D* h;
117 return ( hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
118 }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:74
HiveAlgSequencer.h
h
Definition: HiveAlgSequencer.py:24
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 119 of file Helpers.h.

120 {
121 IHistogram3D* h;
122 return ( hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
123 }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:74
HiveAlgSequencer.h
h
Definition: HiveAlgSequencer.py:24
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 104 of file Helpers.h.

105 {
106 void* h;
107 return System::loadDynamicLib( name, &h );
108 }
HiveAlgSequencer.h
h
Definition: HiveAlgSequencer.py:24
System::loadDynamicLib
GAUDI_API unsigned long loadDynamicLib(const std::string &name, ImageHandle *handle)
Load dynamic link library.
Definition: System.cpp:126

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

Definition at line 124 of file Helpers.h.

125 {
126 IProfile1D* h = 0;
127 return ( hsvc && hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
128 }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:74
HiveAlgSequencer.h
h
Definition: HiveAlgSequencer.py:24
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 129 of file Helpers.h.

130 {
131 IProfile2D* h = 0;
132 return ( hsvc && hsvc->findObject( path, h ).isSuccess() ) ? h : nullptr;
133 }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:74
HiveAlgSequencer.h
h
Definition: HiveAlgSequencer.py:24
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`
| ) |  |
| inline static

Definition at line 56 of file Helpers.h.

57 {
58 return svcloc->service( name, createif ).get();
59 }
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:78

static StatusCode GaudiPython::Helper::setPropertyFromString | ( | Gaudi::Details::PropertyBase & | p,
|  | const std::string & | s
| ) |  |
| inline static

Definition at line 211 of file Helpers.h.

212 {
213 return p.fromString( s );
214 }
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 200 of file Helpers.h.

201 {
202 return v.data();
203 }
std::vector::data
T data(T...args)
template<class T >

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

Definition at line 205 of file Helpers.h.

206 {
207 return (T*)a;
208 }
template<class T >

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

Definition at line 177 of file Helpers.h.

178 {
179 static PyTypeObject type = PyBuffer_Type;
180 static PySequenceMethods meth = *( PyBuffer_Type.tp_as_sequence );
181 #if PY_VERSION_HEX < 0x02050000
182 meth.sq_item = (intargfunc)&Array_item<T>;
183 meth.sq_length = (inquiry)&Array_length<T>;
184 #else
185 meth.sq_item = (ssizeargfunc)&Array_item<T>;
186 meth.sq_length = (lenfunc)&Array_length<T>;
187 #endif
188 type.tp_as_sequence = &meth;
189 PyObject* buf = PyBuffer_FromReadWriteMemory( ptr, size * sizeof( T ) );
190 buf->ob_type = &type;
191 Py_INCREF( buf->ob_type );
192 return buf;
193 }
gaudirun.type
type
Definition: gaudirun.py:125

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

Definition at line 197 of file Helpers.h.

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

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

Definition at line 196 of file Helpers.h.

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

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

Definition at line 194 of file Helpers.h.

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

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

Definition at line 98 of file Helpers.h.

100 {
101 IAlgTool* o;
102 return toolsvc->retrieve( type, name, IAlgTool::interfaceID(), o, p, cif ).isSuccess() ? o : nullptr;
103 }
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:74
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:243
template<class T >

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

Definition at line 149 of file Helpers.h.

150 {
151 return 0;
152 }

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

Definition at line 153 of file Helpers.h.

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

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

Definition at line 154 of file Helpers.h.

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

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

Definition at line 155 of file Helpers.h.

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

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

Definition at line 156 of file Helpers.h.

156 { return PyInt_FromLong( *o ); }

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

Definition at line 157 of file Helpers.h.

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

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

Definition at line 158 of file Helpers.h.

158 { return PyFloat_FromDouble( *o ); }

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

Definition at line 195 of file Helpers.h.

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

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

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