jevois::python::PyParHelper< T > Class Template Reference

#include <jevois/Core/PythonParameter.H>

template<typename T>
class jevois::python::PyParHelper< T >

Typed class to allow creation of Parameter in Python.

Definition at line 62 of file PythonParameter.H.

Inheritance diagram for jevois::python::PyParHelper< T >:

Collaboration diagram for jevois::python::PyParHelper< T >:

Public Member Functions
	PyParHelper (jevois::Component *comp, std::string const &name, std::string const &description, boost::python::object const &defaultValue, jevois::ParameterCategory const &category)
	Create and add the parameter to the component.
virtual	~PyParHelper ()
	Remove param from component.
boost::python::object	get () override
	Get the value, typed, then wrapped into python object.
void	set (boost::python::object const &val) override
	Set the value from python object.
void	setCallback (boost::python::object const &cb) override
	Set the parameter's callback.
void	setValidValues (boost::python::list const &vv) override
	Set valid values that the parameter may take from a list.
std::shared_ptr< jevois::ParameterBase >	par () const override
	Access the associated C++ base parameter, used to forward strget(), strset(), freeze(), etc to it.
Public Member Functions inherited from jevois::python::PyParHelperBase
	PyParHelperBase (jevois::Component *comp)
	Constructor.
virtual	~PyParHelperBase ()
	Remove param from component.

Static Public Member Functions
static std::shared_ptr< jevois::python::PyParHelperBase >	create (jevois::Component *comp, std::string const &name, std::string const &description, boost::python::object const &defaultValue, jevois::ParameterCategory const &category)
	Create and add the parameter to the component.

Protected Attributes
std::shared_ptr< jevois::DynamicParameter< T > >	itsParam
boost::python::object	itsPyCallback

Additional Inherited Members
Protected Member Functions inherited from jevois::python::PyParHelperBase
jevois::Component *	comp () const
	Access the associated C++ Component.

Constructor & Destructor Documentation

PyParHelper()

template<typename T >

jevois::python::PyParHelper< T >::PyParHelper	(	jevois::Component *	comp,
		std::string const &	name,
		std::string const &	description,
		boost::python::object const &	defaultValue,
		jevois::ParameterCategory const &	category
	)

Create and add the parameter to the component.

~PyParHelper()

template<typename T >

virtual jevois::python::PyParHelper< T >::~PyParHelper ( )

virtual

Remove param from component.

Member Function Documentation

create()

template<typename T >

static std::shared_ptr< jevois::python::PyParHelperBase > jevois::python::PyParHelper< T >::create ( jevois::Component *  comp, std::string const &  name, std::string const &  description, boost::python::object const &  defaultValue, jevois::ParameterCategory const &  category  )

static

Create and add the parameter to the component.

get()

template<typename T >

boost::python::object jevois::python::PyParHelper< T >::get ( )

overridevirtual

Get the value, typed, then wrapped into python object.

Implements jevois::python::PyParHelperBase.

par()

template<typename T >

std::shared_ptr< jevois::ParameterBase > jevois::python::PyParHelper< T >::par ( ) const

overridevirtual

Access the associated C++ base parameter, used to forward strget(), strset(), freeze(), etc to it.

Implements jevois::python::PyParHelperBase.

set()

template<typename T >

void jevois::python::PyParHelper< T >::set ( boost::python::object const &  val )

overridevirtual

Set the value from python object.

Implements jevois::python::PyParHelperBase.

setCallback()

template<typename T >

void jevois::python::PyParHelper< T >::setCallback ( boost::python::object const &  cb )

overridevirtual

Set the parameter's callback.

Implements jevois::python::PyParHelperBase.

setValidValues()

template<typename T >

void jevois::python::PyParHelper< T >::setValidValues ( boost::python::list const &  vv )

overridevirtual

Set valid values that the parameter may take from a list.

Implements jevois::python::PyParHelperBase.

Member Data Documentation

itsParam

template<typename T >

std::shared_ptr<jevois::DynamicParameter<T> > jevois::python::PyParHelper< T >::itsParam

protected

Definition at line 93 of file PythonParameter.H.

itsPyCallback

template<typename T >

boost::python::object jevois::python::PyParHelper< T >::itsPyCallback

protected

Definition at line 94 of file PythonParameter.H.

---

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

• include/jevois/Core/PythonParameter.H