OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
PyOpalObject.h File Reference
#include <Python.h>
#include <structmember.h>
#include <memory>
#include <exception>
#include <iostream>
#include <boost/python.hpp>
#include <boost/noncopyable.hpp>
#include <boost/mpl/front.hpp>
#include "Utilities/OpalException.h"
#include "Elements/OpalElement.h"
#include "AbstractObjects/OpalData.h"
#include "AbstractObjects/Object.h"
#include "AbsBeamline/Component.h"
#include "Attributes/Attributes.h"
#include "OpalConfigure/Configure.h"
Include dependency graph for PyOpalObject.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  PyOpal::PyOpalObjectNS::AttributeDef
class  PyOpal::PyOpalObjectNS::PyOpalObject< C >
struct  PyOpal::PyOpalObjectNS::PyOpalObjectGetProperty< C >
struct  PyOpal::PyOpalObjectNS::PyOpalObjectSetProperty< C >

Namespaces

namespace  PyOpal
namespace  PyOpal::PyOpalObjectNS

Enumerations

enum  PyOpal::PyOpalObjectNS::AttributeType {
  PyOpal::PyOpalObjectNS::STRING , PyOpal::PyOpalObjectNS::PREDEFINED_STRING , PyOpal::PyOpalObjectNS::UPPER_CASE_STRING , PyOpal::PyOpalObjectNS::STRING_LIST ,
  PyOpal::PyOpalObjectNS::DOUBLE , PyOpal::PyOpalObjectNS::BOOL , PyOpal::PyOpalObjectNS::INT , PyOpal::PyOpalObjectNS::FLOAT_LIST
}

Functions

template<class C>
void PyOpal::PyOpalObjectNS::update (PyOpalObjectNS::PyOpalObject< C > pyelement)

Variables

Informgmsg
template<class C>
std::map< std::string, AttributeDefPyOpal::PyOpalObjectNS::PyOpalObject< C >::pyNameToAttribute
template<class C>
double PyOpal::PyOpalObjectNS::PyOpalObject< C >::distanceUnits_m = 1
template<class C>
double PyOpal::PyOpalObjectNS::PyOpalObject< C >::timeUnits_m = 1
template<class C>
double PyOpal::PyOpalObjectNS::PyOpalObject< C >::bfieldUnits_m = 1
template<class C>
double PyOpal::PyOpalObjectNS::PyOpalObject< C >::efieldUnits_m = 1
template<class C>
const std::string PyOpal::PyOpalObjectNS::PyOpalObject< C >::getFieldValueDocString
template<class C>
const PyOpalObject< C > * PyOpal::PyOpalObjectNS::PyOpalObjectGetProperty< C >::object_m = nullptr
template<class C>
PyOpalObject< C > * PyOpal::PyOpalObjectNS::PyOpalObjectSetProperty< C >::object_m = nullptr

Class Documentation

◆ PyOpal::PyOpalObjectNS::AttributeDef

struct PyOpal::PyOpalObjectNS::AttributeDef

AttributeDef defines an attribute opalName_m: the name of the opal Attribute pyName_m: the name that will be visible to the user in python. Properties should be_lower_case_with_underscores to comply with python API docString_m: docstring. If left empty (""), PyElement will generate a docstring like "py_name (type): Attribute help string" type_m: python type.

Definition at line 94 of file PyOpalObject.h.

Collaboration diagram for PyOpal::PyOpalObjectNS::AttributeDef:
Class Members
string docString_m
string opalName_m
string pyName_m
AttributeType type_m

Variable Documentation

◆ gmsg

Inform* gmsg
extern

Definition at line 70 of file Main.cpp.