python.h File Reference

Go to the source code of this file.

Macros
#define	LSST_DECLARE_CONTROL_FIELD(WRAPPER, CLASS, NAME)
	Macro used to wrap fields declared by LSST_CONTROL_FIELD using Pybind11. More...
#define	LSST_DECLARE_NESTED_CONTROL_FIELD(WRAPPER, CLASS, NAME)
	Macro used to wrap fields declared by LSST_NESTED_CONTROL_FIELD using Pybind11. More...

Macro Definition Documentation

LSST_DECLARE_CONTROL_FIELD

#define LSST_DECLARE_CONTROL_FIELD	(		WRAPPER,
			CLASS,
			NAME
	)

Value:

    WRAPPER.def_readwrite(#NAME, &CLASS::NAME);                  \
    WRAPPER.def_static("_doc_" #NAME, &CLASS::_doc_ ## NAME);    \
    WRAPPER.def_static("_type_" #NAME, &CLASS::_type_ ## NAME);

Macro used to wrap fields declared by LSST_CONTROL_FIELD using Pybind11.

Example:

LSST_DECLARE_CONTROL_FIELD(clsFoo, Foo, myField)

Parameters

WRAPPER	The py::class_ object representing the control class being wrapped.
CLASS	The control class. Must be a C++ identifier (not a string), properly namespace-qualified for the context where this macro is being called.
NAME	The control field. Must be a C++ identifier (not a string), and must match the NAME argument of the original LSST_CONTROL_FIELD macro.

Definition at line 51 of file python.h.

LSST_DECLARE_NESTED_CONTROL_FIELD

#define LSST_DECLARE_NESTED_CONTROL_FIELD	(		WRAPPER,
			CLASS,
			NAME
	)

Value:

    WRAPPER.def_readwrite(#NAME, &CLASS::NAME);                  \
    WRAPPER.def_static("_doc_" #NAME, &CLASS::_doc_ ## NAME);    \
    WRAPPER.def_static("_type_" #NAME, &CLASS::_type_ ## NAME);  \
    WRAPPER.def_static("_module_" #NAME, &CLASS::_module_ ## NAME);

Macro used to wrap fields declared by LSST_NESTED_CONTROL_FIELD using Pybind11.

Example:

LSST_DECLARE_NESTED_CONTROL_FIELD(clsFoo, Foo, myField)

Parameters

WRAPPER	The py::class_ object representing the control class being wrapped.
CLASS	The control class. Must be a C++ identifier (not a string), properly namespace-qualified for the context where this macro is being called.
NAME	The control field. Must be a C++ identifier (not a string), and must match the NAME argument of the original LSST_CONTROL_FIELD macro.

Definition at line 73 of file python.h.