LSSTApplications  20.0.0
LSSTDataManagementBasePackage
propertyList.cc
Go to the documentation of this file.
1 #include "pybind11/pybind11.h"
2 #include "pybind11/stl.h"
3 
6 
7 namespace py = pybind11;
8 using namespace pybind11::literals;
9 
10 namespace lsst {
11 namespace daf {
12 namespace base {
13 namespace {
14 
15 template <typename T, typename C>
16 void declareAccessors(C& cls, std::string const& name) {
17  const std::string getName = "get" + name;
18  cls.def(getName.c_str(), (T (PropertyList::*)(std::string const&) const) & PropertyList::get<T>,
19  "name"_a);
20  cls.def(getName.c_str(), (T (PropertyList::*)(std::string const&, T const&) const) & PropertyList::get<T>,
21  "name"_a, "defaultValue"_a);
22 
23  // Warning: __len__ is ambiguous so do not attempt to define it. It could return
24  // the number of unique names or the number of entries (e.g. as returned by toList,
25  // a pure Python method). C++ begin and end iterate over unique names, but users often
26  // view PropertyList as a representation of a FITS header. When in doubt, refuse to guess.
27 
28  const std::string getArrayName = "getArray" + name;
29  cls.def(getArrayName.c_str(),
30  (std::vector<T> (PropertyList::*)(std::string const&) const) & PropertyList::getArray<T>,
31  "name"_a);
32 
33  const std::string setName = "set" + name;
34  cls.def(setName.c_str(), (void (PropertyList::*)(std::string const&, T const&)) & PropertyList::set<T>);
35  cls.def(setName.c_str(),
36  (void (PropertyList::*)(std::string const&, std::vector<T> const&)) & PropertyList::set<T>);
37  cls.def(setName.c_str(), (void (PropertyList::*)(std::string const&, T const&, std::string const&)) &
38  PropertyList::set<T>);
39  cls.def(setName.c_str(),
40  (void (PropertyList::*)(std::string const&, std::vector<T> const&, std::string const&)) &
41  PropertyList::set<T>);
42 
43  const std::string addName = "add" + name;
44  cls.def(addName.c_str(), (void (PropertyList::*)(std::string const&, T const&)) & PropertyList::add<T>);
45  cls.def(addName.c_str(),
46  (void (PropertyList::*)(std::string const&, std::vector<T> const&)) & PropertyList::add<T>);
47  cls.def(addName.c_str(), (void (PropertyList::*)(std::string const&, T const&, std::string const&)) &
48  PropertyList::add<T>);
49  cls.def(addName.c_str(),
50  (void (PropertyList::*)(std::string const&, std::vector<T> const&, std::string const&)) &
51  PropertyList::add<T>);
52 
53  const std::string typeName = "TYPE_" + name;
54  cls.attr(typeName.c_str()) = py::cast(typeid(T), py::return_value_policy::reference);
55 }
56 
57 } // namespace
58 
59 PYBIND11_MODULE(propertyList, mod) {
60  py::module::import("lsst.daf.base.persistable");
61 
62  py::class_<PropertyList, std::shared_ptr<PropertyList>, PropertySet> cls(mod, "PropertyList");
63 
64  cls.def(py::init<>());
65 
66  cls.def("getComment", &PropertyList::getComment);
67  cls.def("getOrderedNames", &PropertyList::getOrderedNames);
68  cls.def("deepCopy",
69  [](PropertyList const& self) { return std::static_pointer_cast<PropertySet>(self.deepCopy()); });
70  declareAccessors<bool>(cls, "Bool");
71  declareAccessors<short>(cls, "Short");
72  declareAccessors<int>(cls, "Int");
73  declareAccessors<long>(cls, "Long");
74  declareAccessors<long long>(cls, "LongLong");
75  declareAccessors<float>(cls, "Float");
76  declareAccessors<double>(cls, "Double");
77  declareAccessors<nullptr_t>(cls, "Undef");
78  declareAccessors<std::string>(cls, "String");
79  declareAccessors<DateTime>(cls, "DateTime");
80 
81  cls.def("setPropertySet",
82  (void (PropertyList::*)(std::string const&, PropertySet::Ptr const&)) & PropertyList::set);
83 }
84 
85 } // base
86 } // daf
87 } // lsst
std::string
STL class.
std::shared_ptr< PropertySet >
lsst::daf::base::PYBIND11_MODULE
PYBIND11_MODULE(propertyList, mod)
Definition: propertyList.cc:59
base
Definition: __init__.py:1
std::vector
STL class.
DateTime.h
Interface for DateTime class.
lsst::daf::base::PropertyList
Class for storing ordered metadata with comments.
Definition: PropertyList.h:68
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
PropertyList.h
std::string::c_str
T c_str(T... args)
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::daf::base::PropertySet
Class for storing generic metadata.
Definition: PropertySet.h:67
pybind11
Definition: _GenericMap.cc:40
set
daf::base::PropertySet * set
Definition: fits.cc:912