35 lines
1004 B
Plaintext
35 lines
1004 B
Plaintext
[section boost/python/to_python_value.hpp]
|
|
[section Introduction]
|
|
`to_python_value` is a model of [link concepts.resultconverter ResultConverter] which copies its argument into a new Python object.
|
|
[endsect]
|
|
[section Class template `to_python_value`]
|
|
``
|
|
namespace boost { namespace python
|
|
{
|
|
template <class T>
|
|
struct to_python_value
|
|
{
|
|
typedef typename add_reference<
|
|
typename add_const<T>::type
|
|
>::type argument_type;
|
|
|
|
static bool convertible();
|
|
PyObject* operator()(argument_type) const;
|
|
};
|
|
}}
|
|
``
|
|
[endsect]
|
|
[section Class `to_python_value` observers]
|
|
``static bool convertible();``
|
|
[variablelist
|
|
[[Returns][`true` iff a converter has been registered which can convert `T` to python by-value. ]]
|
|
]
|
|
``PyObject* operator()(argument_type x) const;``
|
|
[variablelist
|
|
[[Requires][`convertible() == true`]]
|
|
[[Effects][converts `x` to python]]
|
|
[[Returns][the resulting Python object iff a converter for `T` has been registered, `0` otherwise. ]]
|
|
]
|
|
[endsect]
|
|
[endsect]
|