lsst.pex.policy  13.0-1-g47a359c+17
policyFile.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 
27 
28 namespace py = pybind11;
29 
30 namespace lsst {
31 namespace pex {
32 namespace policy {
33 
35  py::module mod("policyFile");
36 
37  py::class_<PolicyFile, std::shared_ptr<PolicyFile>, PolicySource> cls(mod, "PolicyFile");
38 
39  // SupportedFormats is not exposed to Python so don't export the default argument
40  cls.def("__init__",
41  [](PolicyFile& self, std::string const& filepath) { new (&self) PolicyFile(filepath); });
42 
43  cls.def("getPath", &PolicyFile::getPath);
44  cls.def("exists", &PolicyFile::exists);
45  cls.def("getFormatName", (const std::string& (PolicyFile::*)()) & PolicyFile::getFormatName);
46  cls.def("load", (void (PolicyFile::*)(Policy&)) & PolicyFile::load);
47 
48  cls.def_readonly_static("EXT_PAF", &PolicyFile::EXT_PAF);
49  cls.def_readonly_static("EXT_XML", &PolicyFile::EXT_XML);
50 
51  return mod.ptr();
52 }
53 
54 } // policy
55 } // pex
56 } // lsst
definition of the PolicyFile class
static const std::string EXT_PAF
Definition: PolicyFile.h:211
a container for holding hierarchical configuration data in memory.
Definition: Policy.h:169
an abstract class representing a source of serialized Policy parameter data.
Definition: PolicySource.h:53
bool exists() const
return true if the file exists.
Definition: PolicyFile.h:181
virtual const std::string & getFormatName()
return the name of the format that the data is stored in.
virtual void load(Policy &policy) const
load the data from this Policy source into a Policy object
definition of the Dictionary class
const std::string getPath() const
return the file path as a string
Definition: PolicyFile.h:176
a representation of a file containing Policy parameter data.
Definition: PolicyFile.h:58
PYBIND11_PLUGIN(defaultPolicyFile)
static const std::string EXT_XML
the PAF file extension, ".paf"
Definition: PolicyFile.h:212