LSSTApplications  20.0.0
LSSTDataManagementBasePackage
dictionary.cc
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2008-2016 AURA/LSST.
4  *
5  * This product includes software developed by the
6  * LSST Project (http://www.lsst.org/).
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <https://www.lsstcorp.org/LegalNotices/>.
21  */
22 
23 #include "pybind11/pybind11.h"
24 #include "pybind11/stl.h"
25 
27 #include "lsst/pex/policy/Policy.h"
29 
30 namespace py = pybind11;
31 using namespace pybind11::literals;
32 
33 namespace lsst {
34 namespace pex {
35 namespace policy {
36 
37 PYBIND11_MODULE(dictionary, mod) {
38  py::class_<Dictionary, std::shared_ptr<Dictionary>, Policy> clsDictionary(mod, "Dictionary");
39 
40  clsDictionary.def(py::init<>());
41  clsDictionary.def(py::init<std::string &>());
42  clsDictionary.def(py::init<const Dictionary &>());
43  clsDictionary.def(py::init<PolicyFile &>());
44  clsDictionary.def(py::init<const Policy &>());
45 
46  clsDictionary.def("getDefinitions", (Policy::Ptr (Dictionary::*)()) & Dictionary::getDefinitions);
47  clsDictionary.def("check", &Dictionary::check);
48  clsDictionary.def("definedNames",
49  (int (Dictionary::*)(std::list<std::string> &, bool) const) & Dictionary::definedNames,
50  "names"_a, "append"_a = false);
51  clsDictionary.def("definedNames",
52  (Dictionary::StringArray (Dictionary::*)() const) & Dictionary::definedNames);
53  clsDictionary.def("getDef", &Dictionary::getDef);
54  clsDictionary.def("makeDef", &Dictionary::makeDef);
55  clsDictionary.def("hasSubDictionary", &Dictionary::hasSubDictionary);
56  clsDictionary.def("getSubDictionary", &Dictionary::getSubDictionary);
57 
58  // For some strange reason pybind11 doesn't like it if we use the default argument here
59  clsDictionary.def("validate",
60  [](Dictionary const &self, Policy const &pol) { return self.validate(pol); }, "pol"_a);
61  clsDictionary.def("validate", [](Dictionary const &self, Policy const &pol,
62  ValidationError *errs) { self.validate(pol, errs); },
63  "pol"_a, "errs"_a);
64 
65  clsDictionary.def("loadPolicyFiles", (int (Dictionary::*)(bool)) & Dictionary::loadPolicyFiles,
66  "strict"_a = true);
67  clsDictionary.def("loadPolicyFiles", [](Dictionary &self, std::string const &repository) {
68  return self.loadPolicyFiles(repository);
69  });
70  clsDictionary.def("loadPolicyFiles", [](Dictionary &self, std::string const &repository, bool strict) {
71  return self.loadPolicyFiles(repository, strict);
72  });
73 
74  clsDictionary.def("getPrefix", &Dictionary::getPrefix);
75 
76  py::class_<Definition> clsDefinition(mod, "Definition");
77 
78  clsDefinition.def(py::init<const std::string &>(), "paramName"_a = "");
79 
80  clsDefinition.def("getName", &Definition::getName);
81  clsDefinition.def("getPrefix", &Definition::getPrefix);
82  clsDefinition.def("setPrefix", &Definition::setPrefix);
83  clsDefinition.def("isChildDefinition", &Definition::isChildDefinition);
84  clsDefinition.def("setChildDefinition", &Definition::setChildDefinition);
85  clsDefinition.def("isWildcard", &Definition::isWildcard);
86  clsDefinition.def("setWildcard", &Definition::setWildcard);
87  clsDefinition.def("setName", &Definition::setName);
88  clsDefinition.def("getData", &Definition::getData);
89  clsDefinition.def("setData", &Definition::setData);
90  clsDefinition.def("getType", &Definition::getType);
91  clsDefinition.def("getTypeName", &Definition::getTypeName);
92  clsDefinition.def("getDefault", &Definition::getDefault);
93  clsDefinition.def("getDescription", &Definition::getDescription);
94  clsDefinition.def("getMaxOccurs", &Definition::getMaxOccurs);
95  clsDefinition.def("getMinOccurs", &Definition::getMinOccurs);
96  clsDefinition.def("check", &Definition::check);
97 }
98 
99 } // policy
100 } // pex
101 } // lsst
std::string
STL class.
std::shared_ptr
STL class.
std::list< std::string >
lsst::pex::policy::Policy
a container for holding hierarchical configuration data in memory.
Definition: Policy.h:167
pex
Definition: __init__.py:1
Policy.h
lsst::pex::policy::PYBIND11_MODULE
PYBIND11_MODULE(dictionary, mod)
Definition: dictionary.cc:37
PolicyFile.h
definition of the PolicyFile class
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
Dictionary.h
definition of the Dictionary class
pybind11
Definition: _GenericMap.cc:40