PyEnge.cpp

Go to the documentation of this file.

#include "PyOpal/PyCore/ExceptionTranslation.h"
#include "PyOpal/PyCore/PyOpalObject.h"
#include "PyOpal/PyCore/Globals.h"
#include "PyOpal/PyElements/PyEndFieldModel.h"

#include "Classic/AbsBeamline/EndFieldModel/EndFieldModel.h"
#include "Elements/OpalEnge.h"

namespace PyOpal {
namespace PyEnge {

const char* module_docstring = 
"enge module holds an Enge end field 'plugin' class for use with field models\n";

template <>
std::vector<PyOpalObjectNS::AttributeDef> PyOpalObjectNS::PyOpalObject<OpalEnge>::attributes = {
    {"X0", "x0", "", PyOpalObjectNS::DOUBLE},
    {"LAMBDA", "enge_lambda", "", PyOpalObjectNS::DOUBLE}, // lambda is a python reserved word
    {"COEFFICIENTS", "coefficients", "", PyOpalObjectNS::FLOAT_LIST},
};

template <>
std::string PyOpalObjectNS::PyOpalObject<OpalEnge>::classDocstring = 
"Enge class is a field element that models a Enge function.\n"
"\n"
"It is referenced and set to field elements by use of the OPAL name (note not\n"
"any python name). The OPAL name is set/retrieved using 'set_opal_name' and\n"
"'get_opal_name' respectively.\n";

BOOST_PYTHON_MODULE(enge) { 
    PyOpal::Globals::Initialise();
    ExceptionTranslation::registerExceptions();
    PyOpalObjectNS::PyOpalObject<OpalEnge> element;
    auto elementClass = element.make_class("Enge");
    elementClass.def("function", &PyOpal::PyEndFieldModel::function<OpalEnge>);
    elementClass.def("update", &PyOpalObjectNS::update<OpalEnge>);
}

}
}