Public Types | Static Public Member Functions | List of all members
eigenpy::StdVectorPythonVisitor< vector_type, NoProxy, EnableFromPythonListConverter > Struct Template Reference

Expose an std::vector from a type given as template argument. More...

#include <std-vector.hpp>

Inheritance diagram for eigenpy::StdVectorPythonVisitor< vector_type, NoProxy, EnableFromPythonListConverter >:
Inheritance graph
[legend]

Public Types

typedef vector_type::allocator_type allocator_type
 
typedef StdContainerFromPythonList< vector_type, NoProxy > FromPythonListConverter
 
typedef vector_type::value_type value_type
 
- Public Types inherited from eigenpy::StdContainerFromPythonList< vector_type, NoProxy >
typedef vector_type::allocator_type Allocator
 
typedef vector_type::value_type T
 

Static Public Member Functions

static void expose (const std::string &class_name, const std::string &doc_string="")
 
template<typename VisitorDerived >
static void expose (const std::string &class_name, const boost::python::def_visitor< VisitorDerived > &visitor)
 
template<typename VisitorDerived >
static void expose (const std::string &class_name, const std::string &doc_string, const boost::python::def_visitor< VisitorDerived > &visitor)
 
- Static Public Member Functions inherited from eigenpy::StdContainerFromPythonList< vector_type, NoProxy >
static void construct (PyObject *obj_ptr, boost::python::converter::rvalue_from_python_stage1_data *memory)
 Allocate the std::vector and fill it with the element contained in the list. More...
 
static void * convertible (PyObject *obj_ptr)
 Check if obj_ptr can be converted. More...
 
static void register_converter ()
 
::boost::python::list tolist (vector_type &self)
 

Detailed Description

template<class vector_type, bool NoProxy = false, bool EnableFromPythonListConverter = true>
struct eigenpy::StdVectorPythonVisitor< vector_type, NoProxy, EnableFromPythonListConverter >

Expose an std::vector from a type given as template argument.

Template Parameters
TType to expose as std::vector<T>.
AllocatorType for the Allocator in std::vector<T,Allocator>.
NoProxyWhen set to false, the elements will be copied when returned to Python.
EnableFromPythonListConverterEnables the conversion from a Python list to a std::vector<T,Allocator>
See also
StdAlignedVectorPythonVisitor

Definition at line 376 of file std-vector.hpp.

Member Typedef Documentation

◆ allocator_type

template<class vector_type, bool NoProxy = false, bool EnableFromPythonListConverter = true>
typedef vector_type::allocator_type eigenpy::StdVectorPythonVisitor< vector_type, NoProxy, EnableFromPythonListConverter >::allocator_type

Definition at line 382 of file std-vector.hpp.

◆ FromPythonListConverter

template<class vector_type, bool NoProxy = false, bool EnableFromPythonListConverter = true>
typedef StdContainerFromPythonList<vector_type, NoProxy> eigenpy::StdVectorPythonVisitor< vector_type, NoProxy, EnableFromPythonListConverter >::FromPythonListConverter

Definition at line 384 of file std-vector.hpp.

◆ value_type

template<class vector_type, bool NoProxy = false, bool EnableFromPythonListConverter = true>
typedef vector_type::value_type eigenpy::StdVectorPythonVisitor< vector_type, NoProxy, EnableFromPythonListConverter >::value_type

Definition at line 381 of file std-vector.hpp.

Member Function Documentation

◆ expose() [1/3]

template<class vector_type, bool NoProxy = false, bool EnableFromPythonListConverter = true>
static void eigenpy::StdVectorPythonVisitor< vector_type, NoProxy, EnableFromPythonListConverter >::expose ( const std::string &  class_name,
const std::string &  doc_string = "" 
)
inlinestatic

Definition at line 386 of file std-vector.hpp.

◆ expose() [2/3]

template<class vector_type, bool NoProxy = false, bool EnableFromPythonListConverter = true>
template<typename VisitorDerived >
static void eigenpy::StdVectorPythonVisitor< vector_type, NoProxy, EnableFromPythonListConverter >::expose ( const std::string &  class_name,
const boost::python::def_visitor< VisitorDerived > &  visitor 
)
inlinestatic

Definition at line 392 of file std-vector.hpp.

◆ expose() [3/3]

template<class vector_type, bool NoProxy = false, bool EnableFromPythonListConverter = true>
template<typename VisitorDerived >
static void eigenpy::StdVectorPythonVisitor< vector_type, NoProxy, EnableFromPythonListConverter >::expose ( const std::string &  class_name,
const std::string &  doc_string,
const boost::python::def_visitor< VisitorDerived > &  visitor 
)
inlinestatic

Definition at line 399 of file std-vector.hpp.


The documentation for this struct was generated from the following file:


eigenpy
Author(s): Justin Carpentier, Nicolas Mansard
autogenerated on Fri Jun 2 2023 02:10:27