|
|
Boost.PythonHeader <boost/python/return_value_policy.hpp> |
return_value_policyreturn_value_policy synopsisreturn_value_policy instantiations are simply models of CallPolicies which are composed of a ResultConverterGenerator
and optional Base CallPolicies.
return_value_policy| Parameter | Requirements | Default |
|---|---|---|
| ResultConverterGenerator | A model of ResultConverterGenerator. | |
Base |
A model of CallPolicies | default_call_policies |
return_value_policy synopsis
namespace boost { namespace python
{
template <class ResultConverterGenerator, class Base = default_call_policies>
struct return_value_policy : Base
{
typedef ResultConverterGenerator result_converter;
};
}}
#include <boost/python/module.hpp>
#include <boost/python/class.hpp>
#include <boost/python/copy_const_reference.hpp>
#include <boost/python/return_value_policy.hpp>
// classes to wrap
struct Bar { int x; }
struct Foo {
Foo(int x) : { b.x = x; }
Bar const& get_bar() const { return b; }
private:
Bar b;
};
// Wrapper code
using namespace boost::python;
BOOST_PYTHON_MODULE(my_module)
{
class_<Bar>("Bar");
class_<Foo>("Foo", init<int>())
.def("get_bar", &Foo::get_bar
, return_value_policy<copy_const_reference>())
;
}
>>> from my_module import * >>> f = Foo(3) # create a Foo object >>> b = f.get_bar() # make a copy of the internal Bar object
Revised 13 November, 2002
© Copyright Dave Abrahams 2002.