Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType > Struct Template Reference

Converts a Python sequence type to a C++ std::vector, where the element type is defined by the template type. More...

#include <PySequenceToVector.h>

Public Types
using	TypedVector = std::vector< DestElementType >

Public Member Functions
void	copyTo (TypedVector &dest)
	Fill the container with data from the array.
TypedVector	operator() ()
	Converts the Python object to a C++ vector.
	PySequenceToVector (const boost::python::object &value)

Private Member Functions
PyObject *	ptr () const
std::size_t	srcSize () const
void	throwIfSizeMismatched (const TypedVector &dest) const

Private Attributes
boost::python::object	m_obj
	Python object to convert.

Detailed Description

template<typename DestElementType>
struct Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >

Converts a Python sequence type to a C++ std::vector, where the element type is defined by the template type.

Definition at line 50 of file PySequenceToVector.h.

Member Typedef Documentation

TypedVector

template<typename DestElementType >

using Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::TypedVector = std::vector<DestElementType>

Definition at line 52 of file PySequenceToVector.h.

Constructor & Destructor Documentation

PySequenceToVector()

template<typename DestElementType >

Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::PySequenceToVector ( const boost::python::object &  value )

inline

Definition at line 54 of file PySequenceToVector.h.

Member Function Documentation

copyTo()

template<typename DestElementType >

void Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::copyTo ( TypedVector &  dest )

inline

Fill the container with data from the array.

Parameters

dest	A vector<DestElementType> that receives the data

Definition at line 71 of file PySequenceToVector.h.

References Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::ptr(), Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::srcSize(), and Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::throwIfSizeMismatched().

Referenced by Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::operator()(), and reorder().

operator()()

template<typename DestElementType >

TypedVector Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::operator() ( )

inline

Converts the Python object to a C++ vector.

Returns

A std::vector<ElementType> containing the values from the Python sequence

Definition at line 61 of file PySequenceToVector.h.

References Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::copyTo(), and Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::srcSize().

ptr()

template<typename DestElementType >

PyObject * Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::ptr ( ) const

inlineprivate

Definition at line 81 of file PySequenceToVector.h.

References Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::m_obj.

Referenced by Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::copyTo(), and Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::srcSize().

srcSize()

template<typename DestElementType >

std::size_t Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::srcSize ( ) const

inlineprivate

Definition at line 83 of file PySequenceToVector.h.

References Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::ptr().

Referenced by Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::copyTo(), Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::operator()(), and Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::throwIfSizeMismatched().

throwIfSizeMismatched()

template<typename DestElementType >

void Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::throwIfSizeMismatched ( const TypedVector &  dest ) const

inlineprivate

Definition at line 85 of file PySequenceToVector.h.

References Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::srcSize(), and std::to_string().

Referenced by Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::copyTo().

Member Data Documentation

m_obj

template<typename DestElementType >

boost::python::object Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::m_obj

private

Python object to convert.

Definition at line 93 of file PySequenceToVector.h.

Referenced by Mantid::PythonInterface::Converters::PySequenceToVector< DestElementType >::ptr().

---

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

• Framework/PythonInterface/core/inc/MantidPythonInterface/core/Converters/PySequenceToVector.h