source: src/Python/PythonScripting_impl.hpp@ ea30e6

Candidate_v1.7.0 stable
Last change on this file since ea30e6 was ea30e6, checked in by Frederik Heber <frederik.heber@…>, 5 years ago

Added python getters for selected atom ids and elements.

  • Property mode set to 100644
File size: 5.5 KB
Line 
1/*
2 * PythonScripting.hpp
3 *
4 * Created on: Apr 13, 2012
5 * Author: heber
6 */
7
8#ifndef PYTHONSCRIPTING_IMPL_HPP_
9#define PYTHONSCRIPTING_IMPL_HPP_
10
11
12// include config.h
13#ifdef HAVE_CONFIG_H
14#include <config.h>
15#endif
16
17
18#include <boost/python.hpp>
19#include <boost/python/module.hpp>
20#include <boost/python/args.hpp>
21
22#include "CodePatterns/toString.hpp"
23
24// all "getter" functions
25#include "modules.hpp"
26
27//!> define all present actions
28#include "GlobalListOfActions.hpp"
29
30//!> python wrapping for all of these actions
31#include "AllActionPython.hpp"
32
33namespace MoleCuilder {
34
35namespace PythonTypes {
36
37inline void IndexError(){
38 PyErr_SetString(PyExc_IndexError, "Index out of range");
39 boost::python::throw_error_already_set();
40}
41
42template<class T>
43struct vec_item{
44 typedef typename T::value_type V;
45 static V& get(T& x, int i){
46 static V nothing;
47 if(i < 0) i += x.size();
48 if(i >= 0 && i < int(x.size())) return x[i];
49 IndexError();
50 return nothing;
51 }
52 static void set(T& x, int i, V const& v){
53 if(i < 0) i += x.size();
54 if(i >= 0 && i < int(x.size())) x[i] = v;
55 else IndexError();
56 }
57 static void del(T& x, int i){
58 if(i < 0) i += x.size();
59 if(i >= 0 && i < int(x.size())) x.erase(x.begin() + i);
60 else IndexError();
61 }
62 static void add(T& x, V const& v){
63 x.push_back(v);
64 }
65};
66
67
68} /* namespace PythonTypes */
69
70} /* namespace MoleCuilder */
71
72
73BOOST_PYTHON_MODULE(pyMoleCuilder)
74{
75 // from this moment on, we need to be sure to deeinitialize in the correct or
76 // this is handled by the cleanup function
77 atexit(MoleCuilder::detail::module_exit);
78
79 // set the docstring of the current module scope
80 boost::python::scope().attr("__doc__") = "pyMolecuilder are the python bindings to all Actions of the program suite MoleCuilder.\n\nMoleCuilder is a program to build molecular (dynamics) worlds, allowing you indefinite manipulation, control and analysis over the atoms and molecules within a simulation domain.";
81
82 boost::python::def(
83 "reinit",
84 MoleCuilder::detail::module_reinit,
85 "Reinitializes the internal state of the python module as if it had been freshly imported,saves all input files beforehand."
86 );
87 boost::python::def(
88 "wait",
89 MoleCuilder::detail::module_wait,
90 "Waits until all currently queued actions have been processed."
91 );
92 boost::python::def< MoleCuilder::detail::doubleVec() >(
93 "getBoundingBox",
94 MoleCuilder::detail::module_getBoundingBox,
95 "returns the cuboid bounding box of the current domain."
96 );
97 boost::python::def< double() >(
98 "getDomainVolume",
99 MoleCuilder::detail::module_getDomainVolume,
100 "returns the volume of the simulation domain."
101 );
102 boost::python::def< MoleCuilder::detail::elementVec() >(
103 "getSelectedAtomElements",
104 MoleCuilder::detail::module_getSelectedAtomElements,
105 "returns the element numbers of all currently selected atoms."
106 );
107 boost::python::def< MoleCuilder::detail::atomIdVec() >(
108 "getSelectedAtomIds",
109 MoleCuilder::detail::module_getSelectedAtomIds,
110 "returns the ids of all currently selected atoms."
111 );
112 boost::python::def< double() >(
113 "getSelectedMolarMass",
114 MoleCuilder::detail::module_getSelectedMolarMass,
115 "returns the molar mass of all selected atoms."
116 );
117
118 // STL Vectors:
119 // unsignedIntVec
120 boost::python::class_< std::vector< atomId_t > >("PythonType_unsignedIntVec")
121 .def("__len__", &std::vector< unsigned int >::size)
122 .def("clear", &std::vector< unsigned int >::clear)
123 .def("append", &MoleCuilder::PythonTypes::vec_item< std::vector< unsigned int > >::add,
124 boost::python::with_custodian_and_ward<1, 2>()) // let container keep value
125 .def("__getitem__", &MoleCuilder::PythonTypes::vec_item< std::vector< unsigned int > >::get,
126 boost::python::return_value_policy<boost::python::copy_non_const_reference>())
127 .def("__setitem__", &MoleCuilder::PythonTypes::vec_item< std::vector< unsigned int > >::set,
128 boost::python::with_custodian_and_ward<1,2>()) // to let container keep value
129 .def("__delitem__", &MoleCuilder::PythonTypes::vec_item< std::vector< unsigned int > >::del)
130 .def("__iter__", boost::python::iterator< std::vector< unsigned int > >())
131 ;
132 // doubleVec
133 boost::python::class_< std::vector< double > >("PythonType_doubleVec")
134 .def("__len__", &std::vector< double >::size)
135 .def("clear", &std::vector< double >::clear)
136 .def("append", &MoleCuilder::PythonTypes::vec_item< std::vector< double > >::add,
137 boost::python::with_custodian_and_ward<1, 2>()) // let container keep value
138 .def("__getitem__", &MoleCuilder::PythonTypes::vec_item< std::vector< double > >::get,
139 boost::python::return_value_policy<boost::python::copy_non_const_reference>())
140 .def("__setitem__", &MoleCuilder::PythonTypes::vec_item< std::vector< double > >::set,
141 boost::python::with_custodian_and_ward<1,2>()) // to let container keep value
142 .def("__delitem__", &MoleCuilder::PythonTypes::vec_item< std::vector< double > >::del)
143 .def("__iter__", boost::python::iterator< std::vector< double > >())
144 ;
145
146 // access to all Actions
147#define export_print(z,n,list) \
148 BOOST_PP_CAT(export_, BOOST_PP_SEQ_ELEM(n, list))();
149#define BOOST_PP_LOCAL_MACRO(n) export_print(~, n, GLOBALLISTOFPYTHONACTIONS)
150#define BOOST_PP_LOCAL_LIMITS (0, BOOST_PP_DEC(BOOST_PP_SEQ_SIZE(GLOBALLISTOFPYTHONACTIONS)))
151#include BOOST_PP_LOCAL_ITERATE()
152#undef instance_print
153}
154
155
156#endif /* PYTHONSCRIPTING_IMPL_HPP_ */
Note: See TracBrowser for help on using the repository browser.