#include <PyOpalObject.h>

Inheritance diagram for PyOpal::PyOpalObjectNS::PyOpalObject< C >:

Public Types
typedef PyOpalObject< C >	PyC

Public Member Functions
	PyOpalObject ()

	PyOpalObject (std::shared_ptr< C > object)

	PyOpalObject (const PyOpalObject< C > &rhs)

	~PyOpalObject ()

boost::python::class_< PyC >	make_class (const char *className)

boost::python::class_< PyC >	make_element_class (const char *className)

boost::python::class_< PyC >	make_generic_class (const char *className)

template<class PYCLASS >
void	addAttributes (PYCLASS &pyclass)

template<class PYCLASS >
void	addExecute (PYCLASS &pyclass)

template<class PYCLASS >
void	addRegister (PYCLASS &pyclass)

template<class PYCLASS >
void	addGetOpalName (PYCLASS &pyclass)

template<class PYCLASS >
void	addSetAttributes (PYCLASS &pyclass)

template<class PYCLASS >
void	addSetOpalName (PYCLASS &pyclass)

template<class PYCLASS >
void	addSetOpalElementName (PYCLASS &pyclass)

template<class PYCLASS >
void	addGetOpalElement (PYCLASS &pyclass)

template<class PYCLASS >
void	addGetFieldValue (PYCLASS &pyclass, double distanceUnits, double timeUnits, double bfieldUnits, double efieldUnits)

template<class ValueType >
ValueType	dummyGet () const

virtual void	doSetup ()

template<class ValueType >
void	dummySet (ValueType test)

PyObject *	getAttribute (AttributeType type, std::string opalName) const

void	setAttribute (AttributeType type, std::string opalName, PyObject *value)

std::shared_ptr< C >	getOpalShared ()

std::shared_ptr< C >	getOpalShared () const

template<>
	PyOpalObject ()

template<>
void	doSetup ()

template<>
void	doSetup ()

template<>
void	doSetup ()

Protected Member Functions
std::string	getDocString (AttributeDef &def)

Static Protected Member Functions
static boost::python::object	getFieldValue (PyOpalObjectNS::PyOpalObject< C > &pyobject, double x, double y, double z, double t)

static std::string	getOpalName (const PyOpalObject< C > &pyobject)

static void	setOpalName (PyOpalObject< C > &pyobject, std::string name)

static void	setOpalElementName (PyOpalObject< C > &pyobject, std::string name)

static void	execute (PyOpalObject< C > &pyobject)

static void	registerObject (PyOpalObject< C > &pyobject)

static boost::python::object	getPyOpalElement (PyOpalObject< C > &pyobject)

static boost::python::object	setAttributes (boost::python::tuple args, boost::python::dict kwargs)

Protected Attributes
std::shared_ptr< C >	object_m

Static Protected Attributes
static std::vector< AttributeDef >	attributes

static std::map< std::string, AttributeDef >	pyNameToAttribute

static std::string	classDocstring

static bool	converterRegistered

static double	distanceUnits_m = 1

static double	timeUnits_m = 1

static double	bfieldUnits_m = 1

static double	efieldUnits_m = 1

static const std::string	getFieldValueDocString

Detailed Description

template<class C>
class PyOpal::PyOpalObjectNS::PyOpalObject< C >

PyOpalObject<C> is the basic wrapper class for Opal Objects

PyOpalObject<C> is a wrapper for an Opal Object C. Opal Attributes are implemented in python as properties (public member data). Some default method calls can be enabled in the concrete implementation by setting flags. Docstring can be enabled by setting classDocString.

element_m: pointer to the base element attributes: vector of attributes. The order of the vector is the order that attributes will appear in the docstring classDocString: overall docstring. docstrings on each property and method are added automatically by the framework.

property access is set up in make_class using add_property from boost::python. Normally, the "get" method can't take any data; this would mean that we can't pass an Attribute name for the OpalElement lookup. In order to get around this limitation, we have a "dummy" getter dummyGet. Then there is a "real" getter, which is hidden in the call policy for the property (a sort of pre- and post- decorator). We use PyOpalObjectGetProperty to hold the Attribute name and then dummyGet just tells PyElementGetProperty the address of the PyOpalObject. PyElementGetProperty does a postcall action to overwrite the return value with the "real" return value, based on the stored Attribute name.

Setters work in exactly the same way, except now we have dummySet and PyElementSetProperty to handle the interface.

The routine then looks like: python::boost calls dummyGet; dummyGet tells PyElementGetProperty pointer to PyOpalObject python::boost calls PyElementGetProperty.postcall PyElementGetProperty.postcall calls PyOpalObject->getAttribute; where getAttribute takes the name of the Attribute as a string. It's a bit of a faff.

Definition at line 69 of file PyOpalObject.h.

Member Typedef Documentation

template<class C>

typedef PyOpalObject<C> PyOpal::PyOpalObjectNS::PyOpalObject< C >::PyC

Definition at line 140 of file PyOpalObject.h.

Constructor & Destructor Documentation

template<class C >

PyOpal::PyOpalObjectNS::PyOpalObject< C >::PyOpalObject ( )

inline

Default constructor

Definition at line 530 of file PyOpalObject.h.

template<class C>

PyOpal::PyOpalObjectNS::PyOpalObject< C >::PyOpalObject ( std::shared_ptr< C > object )

inline

Constructor taking the element as argument

Definition at line 144 of file PyOpalObject.h.

template<class C >

PyOpal::PyOpalObjectNS::PyOpalObject< C >::PyOpalObject ( const PyOpalObject< C > & rhs )

Copying is disabled

Definition at line 693 of file PyOpalObject.h.

template<class C>

PyOpal::PyOpalObjectNS::PyOpalObject< C >::~PyOpalObject ( )

inline

Default destructor

Definition at line 148 of file PyOpalObject.h.

template<>

PyOpal::PyOpalObjectNS::PyOpalObject< OpalElement >::PyOpalObject ( )

Member Function Documentation

template<class C >

template<class PYCLASS >

void PyOpal::PyOpalObjectNS::PyOpalObject< C >::addAttributes ( PYCLASS & pyclass )

Add attributes to the python class.

Definition at line 820 of file PyOpalObject.h.

References PyOpal::PyOpalObjectNS::BOOL, PyOpal::PyOpalObjectNS::DOUBLE, PyOpal::PyOpalObjectNS::FLOAT_LIST, PyOpal::PyOpalObjectNS::INT, PyOpal::PyOpalObjectNS::PREDEFINED_STRING, PyOpal::PyOpalObjectNS::STRING, PyOpal::PyOpalObjectNS::STRING_LIST, and PyOpal::PyOpalObjectNS::UPPER_CASE_STRING.

template<class C >

template<class PYCLASS >

void PyOpal::PyOpalObjectNS::PyOpalObject< C >::addExecute ( PYCLASS & pyclass )

Add an "execute" method to the python class (e.g. if it is an ACTION)

Definition at line 761 of file PyOpalObject.h.

Referenced by PyOpal::PyDistributionNS::BOOST_PYTHON_MODULE(), PyOpal::PyTrackRunNS::BOOST_PYTHON_MODULE(), and PyOpal::PyOptionNS::BOOST_PYTHON_MODULE().

template<class C >

template<class PYCLASS >

void PyOpal::PyOpalObjectNS::PyOpalObject< C >::addGetFieldValue	(	PYCLASS &	pyclass,
		double	distanceUnits,
		double	timeUnits,
		double	bfieldUnits,
		double	efieldUnits
	)

Add a "get_field_value" method to the python class (for elements that expose a field)

PYCLASS: instance of the class to which the field is added
distanceUnits: set the distance units so that UI is in OPAL units
timeUnits: set the time units so that UI is in OPAL units
bfieldUnits: set the bfield units so that UI is in OPAL units
efieldUnits: set the efield units so that UI is in OPAL units

It is encouraged to expose the field map for field-type objects, for user to check that the field is as expected.

Note that conversion factors for units in distance, time, bfield and efield should be provided - the OPAL unit system should be exposed to user (see OPAL docs for current recommendation). Opal will call element->apply(R*distanceUnits, P, t*timeUnits, Efield, Bfield) and return Efield*efieldUnits, BField*bfield units.

Definition at line 805 of file PyOpalObject.h.

Referenced by PyOpal::PyVerticalFFAMagnet::BOOST_PYTHON_MODULE(), PyOpal::PyMultipoleT::BOOST_PYTHON_MODULE(), PyOpal::PyVariableRFCavity::BOOST_PYTHON_MODULE(), PyOpal::PyVariableRFCavityFringeField::BOOST_PYTHON_MODULE(), PyOpal::PyScalingFFAMagnet::BOOST_PYTHON_MODULE(), and PyOpal::PyRingDefinition::BOOST_PYTHON_MODULE().

template<class C >

template<class PYCLASS >

void PyOpal::PyOpalObjectNS::PyOpalObject< C >::addGetOpalElement ( PYCLASS & pyclass )

Add a "get_opal_element" method to the python class (to overload as a PyOpalElement)

This is required for OpalElement objects, in order that they can be used in a OPAL line object (for setting up beamlines having multiple elements). In general, if C is an OpalElement, developer should call addGetOpalElement in the module setup function.

Definition at line 799 of file PyOpalObject.h.

Referenced by PyOpal::PyLineNS::BOOST_PYTHON_MODULE().

template<class C >

template<class PYCLASS >

void PyOpal::PyOpalObjectNS::PyOpalObject< C >::addGetOpalName ( PYCLASS & pyclass )

Add a get_opal_name method to the python class (to get the opal internal string that uniquely identifies the object)

Definition at line 773 of file PyOpalObject.h.

template<class C >

template<class PYCLASS >

void PyOpal::PyOpalObjectNS::PyOpalObject< C >::addRegister ( PYCLASS & pyclass )

Add a "register" method to the python class (to register against opal global data object)

Definition at line 767 of file PyOpalObject.h.

Referenced by PyOpal::PyBeamNS::BOOST_PYTHON_MODULE().

template<class C >

template<class PYCLASS >

void PyOpal::PyOpalObjectNS::PyOpalObject< C >::addSetAttributes ( PYCLASS & pyclass )

Add a set_attributes method to the python class (to setup opalobject from a dictionary of kwargs)

Definition at line 779 of file PyOpalObject.h.

template<class C >

template<class PYCLASS >

void PyOpal::PyOpalObjectNS::PyOpalObject< C >::addSetOpalElementName ( PYCLASS & pyclass )

Add a set_opal_name method to the python class (to set the opal internal string that uniquely identifies the object). This version has bindings specifically for OpalElements

Definition at line 793 of file PyOpalObject.h.

template<class C >

template<class PYCLASS >

void PyOpal::PyOpalObjectNS::PyOpalObject< C >::addSetOpalName ( PYCLASS & pyclass )

Add a set_opal_name method to the python class (to set the opal internal string that uniquely identifies the object)

Definition at line 787 of file PyOpalObject.h.

template<>

void PyOpal::PyOpalObjectNS::PyOpalObject< OpalScalingFFAMagnet >::doSetup ( )

Overload this method on the PyOpalObject - it is supposed to be called every time the magnet is updated (i.e. every time get_field_value is called from python).

The point is the EndFieldModel could have changed and we redo setup just in case (terribly inefficient)

Definition at line 32 of file PyScalingFFAMagnet.cpp.

References magnet, and ScalingFFAMagnet::setupEndField().

Here is the call graph for this function:

template<>

void PyOpal::PyOpalObjectNS::PyOpalObject< OpalVariableRFCavityFringeField >::doSetup ( )

Overload this method on the PyOpalObject - it is supposed to be called every time the cavity is updated (i.e. every time get_field_value is called from python).

The point is the TimeDependence could have changed and we redo setup just in case (terribly inefficient, but only effects python side)

Definition at line 35 of file PyVariableRFCavityFringeField.cpp.

References VariableRFCavityFringeField::initialise().

Here is the call graph for this function:

template<>

void PyOpal::PyOpalObjectNS::PyOpalObject< OpalVariableRFCavity >::doSetup ( )

Overload this method on the PyOpalObject - it is supposed to be called every time the cavity is updated (i.e. every time get_field_value is called from python).

The point is the TimeDependence could have changed and we redo setup just in case (terribly inefficient, but only effects python side)

Definition at line 35 of file PyVariableRFCavity.cpp.

References VariableRFCavity::initialise().

Here is the call graph for this function:

template<class C>

virtual void PyOpal::PyOpalObjectNS::PyOpalObject< C >::doSetup ( )

inlinevirtual

Overload the method to perform any additional setup that can be made before the OpalObject is accessed, after OpalObject->update() is called.

Definition at line 258 of file PyOpalObject.h.

Referenced by PyOpal::PyOpalObjectNS::PyOpalObject< C >::getFieldValue().

template<class C>

template<class ValueType >

ValueType PyOpal::PyOpalObjectNS::PyOpalObject< C >::dummyGet ( ) const

inline

dummyGet sets the object ptr for PyOpalObjectGetProperty but doesn't actually do the get(...)

Definition at line 253 of file PyOpalObject.h.

References PyOpal::PyOpalObjectNS::PyOpalObjectGetProperty< C >::setObject().

Here is the call graph for this function:

template<class C >

template<class ValueType >

void PyOpal::PyOpalObjectNS::PyOpalObject< C >::dummySet ( ValueType test )

inline

dummySet sets the element ptr for PyOpalObjectSetProperty but doesn't actually do the set(...)

Definition at line 347 of file PyOpalObject.h.

References PyOpal::PyOpalObjectNS::PyOpalObjectSetProperty< C >::setObject(), and void.

Here is the call graph for this function:

template<class C >

void PyOpal::PyOpalObjectNS::PyOpalObject< C >::execute ( PyOpalObject< C > & pyobject )

staticprotected

method to call "execute" on an object

Definition at line 473 of file PyOpalObject.h.

References PyOpal::PyOpalObjectNS::PyOpalObject< C >::getOpalShared().

Referenced by minimal_runner.MinimalRunner::execute_fork().

Here is the call graph for this function:

template<class C >

PyObject * PyOpal::PyOpalObjectNS::PyOpalObject< C >::getAttribute	(	AttributeType	type,
		std::string	opalName
	)		const

Get the value of an attribute

type: the type expected for python
opalName: the name of the Opal Attribute Returns a PyObject holding data; INCREF is called on the object i.e. it is a new object, not borrowed.

It is an error if the Attribute does not exist (throws OpalException)

Definition at line 533 of file PyOpalObject.h.

References PyOpal::PyOpalObjectNS::attributeName, PyOpal::PyOpalObjectNS::BOOL, PyOpal::PyOpalObjectNS::DOUBLE, PyOpal::PyOpalObjectNS::FLOAT_LIST, Attributes::getBool(), Attributes::getReal(), Attributes::getRealArray(), Attributes::getString(), Attributes::getStringArray(), PyOpal::PyOpalObjectNS::INT, PyOpal::PyOpalObjectNS::PREDEFINED_STRING, PyOpal::PyOpalObjectNS::STRING, PyOpal::PyOpalObjectNS::STRING_LIST, and PyOpal::PyOpalObjectNS::UPPER_CASE_STRING.

Here is the call graph for this function:

template<class C >

std::string PyOpal::PyOpalObjectNS::PyOpalObject< C >::getDocString ( AttributeDef & def )

protected

pointer to the element Generates a docstring from the attribute

Definition at line 697 of file PyOpalObject.h.

References PyOpal::PyOpalObjectNS::attributeName, PyOpal::PyOpalObjectNS::AttributeDef::docString_m, Attribute::getHelp(), PyOpal::PyOpalObjectNS::AttributeDef::opalName_m, PyOpal::PyOpalObjectNS::AttributeDef::pyName_m, and PyOpal::PyOpalObjectNS::AttributeDef::type_m.

Here is the call graph for this function:

template<class C >

boost::python::object PyOpal::PyOpalObjectNS::PyOpalObject< C >::getFieldValue	(	PyOpalObjectNS::PyOpalObject< C > &	pyobject,
		double	x,
		double	y,
		double	z,
		double	t
	)

staticprotected

method to get field at a point in space-time

Definition at line 353 of file PyOpalObject.h.

References Component::apply(), component(), PyOpal::PyOpalObjectNS::PyOpalObject< C >::doSetup(), PyOpal::PyOpalObjectNS::PyOpalObject< C >::getOpalShared(), and Attrib::Distribution::R.

Here is the call graph for this function:

template<class C >

std::string PyOpal::PyOpalObjectNS::PyOpalObject< C >::getOpalName ( const PyOpalObject< C > & pyobject )

staticprotected

method to get the opal name of an object

Definition at line 491 of file PyOpalObject.h.

References PyOpal::PyOpalObjectNS::PyOpalObject< C >::getOpalShared().

Here is the call graph for this function:

template<class C>

std::shared_ptr<C> PyOpal::PyOpalObjectNS::PyOpalObject< C >::getOpalShared ( )

inline

Returns the Opal Object from the PyOpalObject

Definition at line 286 of file PyOpalObject.h.

References PyOpal::PyOpalObjectNS::PyOpalObject< C >::object_m.

Referenced by PyOpal::PyOpalObjectNS::PyOpalObject< C >::execute(), PyOpal::PyTrackCmdNS::executeWrapper(), PyOpal::PyOpalObjectNS::PyOpalObject< C >::getFieldValue(), PyOpal::PyOpalObjectNS::PyOpalObject< C >::getOpalName(), PyOpal::PyOpalObjectNS::PyOpalObject< C >::getPyOpalElement(), PyOpal::PyDistributionNS::registerDistribution(), PyOpal::PyFieldSolverNS::registerFieldSolver(), PyOpal::PyOpalObjectNS::PyOpalObject< C >::registerObject(), PyOpal::PyLine_< C >::setElement(), PyOpal::PyOpalObjectNS::PyOpalObject< C >::setOpalElementName(), PyOpal::PyOpalObjectNS::PyOpalObject< C >::setOpalName(), and PyOpal::PyOpalObjectNS::update().

template<class C>

std::shared_ptr<C> PyOpal::PyOpalObjectNS::PyOpalObject< C >::getOpalShared ( ) const

inline

Returns the Opal Object from the PyOpalObject (const version)

Definition at line 289 of file PyOpalObject.h.

References PyOpal::PyOpalObjectNS::PyOpalObject< C >::object_m.

template<class C >

boost::python::object PyOpal::PyOpalObjectNS::PyOpalObject< C >::getPyOpalElement ( PyOpalObjectNS::PyOpalObject< C > & pyobject )

staticprotected

return the underlying element (used e.g. by PyLine)

Definition at line 512 of file PyOpalObject.h.

References PyOpal::PyOpalObjectNS::PyOpalObject< C >::getOpalShared().

Here is the call graph for this function:

template<class C >

boost::python::class_< PyOpalObject< C > > PyOpal::PyOpalObjectNS::PyOpalObject< C >::make_class ( const char * className )

inline

This is the basic method to make a class for OpalObjects. It should normally be called when the module is declared, BOOST_PYTHON_MODULE.

Note that while in principle this could be static, in the end we need an instance of C so that we can access the docString from the attribute.

Definition at line 745 of file PyOpalObject.h.

Referenced by PyOpal::PyEnge::BOOST_PYTHON_MODULE(), PyOpal::PyOpalPolynomialTimeDependence::BOOST_PYTHON_MODULE(), PyOpal::PyDistributionNS::BOOST_PYTHON_MODULE(), PyOpal::PyBeamNS::BOOST_PYTHON_MODULE(), PyOpal::PyTrackCmdNS::BOOST_PYTHON_MODULE(), PyOpal::PyTrackRunNS::BOOST_PYTHON_MODULE(), PyOpal::PyFieldSolverNS::BOOST_PYTHON_MODULE(), and PyOpal::PyOptionNS::BOOST_PYTHON_MODULE().

template<class C >

boost::python::class_< PyOpalObject< C > > PyOpal::PyOpalObjectNS::PyOpalObject< C >::make_element_class ( const char * className )

inline

This is the basic method to make a class for elements.

This differs from make_class(...) because the setOpalName method sets the underlying element name at the same time.

Definition at line 752 of file PyOpalObject.h.

template<class C >

boost::python::class_< PyOpalObject< C > > PyOpal::PyOpalObjectNS::PyOpalObject< C >::make_generic_class ( const char * className )

inline

This is the basic method to make a class for generic Opal object type.

In this one, the setOpalName method is not assigned, and user has to assign it (if they want it)

Definition at line 711 of file PyOpalObject.h.

References endl(), exception, and ClassicException::what().

Here is the call graph for this function:

template<class C >

void PyOpal::PyOpalObjectNS::PyOpalObject< C >::registerObject ( PyOpalObjectNS::PyOpalObject< C > & pyobject )

staticprotected

method to call "register" on an object

Definition at line 479 of file PyOpalObject.h.

References OpalData::define(), OpalData::getInstance(), and PyOpal::PyOpalObjectNS::PyOpalObject< C >::getOpalShared().

Here is the call graph for this function:

template<class C >

void PyOpal::PyOpalObjectNS::PyOpalObject< C >::setAttribute	(	AttributeType	type,
		std::string	opalName,
		PyObject *	value
	)

Set the value of an attribute

type: the type expected for python
opalName: the name of the Opal Attribute
value: Python object holding the value to be stored. value refcnt is not changed - caller is responsible for managing the refcnt. It is an error if the Attribute does not exist (throws OpalException)

Definition at line 610 of file PyOpalObject.h.