docs/config_8cpp_source.html

#include "conffwk/Configuration.hpp"

#include "conffwk/ConfigObject.hpp"

#include "conffwk/Schema.hpp"

#include "conffwk/set.hpp"


#include <pybind11/pybind11.h>

#include <pybind11/stl.h>

#include <pybind11/stl_bind.h>


#include <list>

#include <string>

#include <vector>


namespace py = pybind11;


namespace dunedaq::conffwk::python {


void


register_conffwk(py::module& m)

{


  py::class_<Configuration>(m, "_Configuration")

    .def(py::init<>())

    .def(py::init<std::string>())

    .def("add_include",

     &Configuration::add_include, "Add include file to existing database.", py::arg("db_name"), py::arg("include"))

    .def("attributes",

     &Configuration::attributes_pybind, "Get the properties of each attribute in a given class", py::arg("class_name"), py::arg("all"))

    .def("classes",

     &Configuration::get_class_list, "Get the names of the superclasses for each class")

    .def("commit",

     &Configuration::commit, "Commit database changes.", py::arg("log_message") = "")

    .def("create_db",

     static_cast<void (Configuration::*)(const std::string&, const std::list<std::string>&)>(&Configuration::create), "Create a database from a list of files", py::arg("db_name"), py::arg("includes"))

    .def("create_obj",

     py::overload_cast<const std::string&, const std::string&, const std::string&>(&Configuration::create_and_return_obj_pybind), "Create new object by class name and object id.", py::arg("at"), py::arg("class_name"), py::arg("id"))

    .def("create_obj",

     py::overload_cast<const ConfigObject&, const std::string&, const std::string&>(&Configuration::create_and_return_obj_pybind), "Create new object by class name and object id.", py::arg("at"), py::arg("class_name"), py::arg("id"))

    .def("destroy_obj",

     &Configuration::destroy_obj, "The method tries to destroy given object.", py::arg("object"))

    .def("get_impl_param",

     &Configuration::get_impl_param, "Get implementation plug-in parameter used to build conffwk object")

    .def("get_impl_spec",

     &Configuration::get_impl_spec, "Get implementation plug-in and its parameter used to build conffwk object")

    .def("get_includes",

     &Configuration::return_includes_pybind, "Returns list of files included by given database.", py::arg("db_name"))

    .def("get_schema_path",

       &Configuration::get_schema_path_pybind, "Get path to schema file with definition of the given class", py::arg("class_name"))

    .def("get_obj",

         &Configuration::get_obj_pybind, "Create a configuration object containing the desired entity from the database", py::arg("class_name"), py::arg("id"))

    .def("get_objs",

     &Configuration::get_objs_pybind, "Create a list of configuration objects of a given class from the database", py::arg("class_name"), py::arg("query") = "")

    .def("load",

     &Configuration::load, "Load database according to the name.", py::arg("db_name"))

    .def("loaded",

     &Configuration::loaded, "Check if database is correctly loaded.")

    .def("remove_include",

     &Configuration::remove_include, "Remove include file.", py::arg("db_name"), py::arg("include"))

    .def("relations",

     &Configuration::relations_pybind, "Get the properties of each relation in a given class", py::arg("class_name"), py::arg("all"))

    .def("superclasses",

     &Configuration::superclasses_pybind, "Get the superclasses of a single class", py::arg("class_name"), py::arg("all"))

    .def("subclasses",

     &Configuration::subclasses_pybind, "Get the subclasses of a single class", py::arg("class_name"), py::arg("all"))

    .def("test_object",

         &Configuration::test_object, "Test the existence of the object", py::arg("class_name"), py::arg("id"), py::arg("rlevel"), py::arg("rclasses"))

    .def("unload",

     &Configuration::unload, "Unload previously-loaded database")

    ;

}


void


register_conffwkobject(py::module& m)

{


  py::class_<ConfigObject>(m, "_ConfigObject")

    .def(py::init<>())

    .def(py::init<const ConfigObject&>())

    .def("class_name",

     &ConfigObject::class_name, "Return object's class name")

    .def("contained_in",

     &ConfigObject::contained_in, "Return the name of the database file this object belongs to.")

    .def("full_name",

     &ConfigObject::full_name, "Return full object name")

    .def("get_obj",

     &ConfigObject::get_obj_pybind, "Get a copy of an object", py::arg("attrname"))

    .def("get_objs",

     &ConfigObject::get_list_pybind<ConfigObject>, "Getter function for a list", py::arg("attr"))

    .def("get_string",

     &ConfigObject::get_value_pybind<std::string>, "Simple getter function", py::arg("attr"))

    .def("get_bool",

     &ConfigObject::get_value_pybind<bool>, "Simple getter function", py::arg("attr"))

    .def("get_s8",

     &ConfigObject::get_value_pybind<int8_t>, "Simple getter function", py::arg("attr"))

    .def("get_u8",

     &ConfigObject::get_value_pybind<uint8_t>, "Simple getter function", py::arg("attr"))

    .def("get_s16",

     &ConfigObject::get_value_pybind<int16_t>, "Simple getter function", py::arg("attr"))

    .def("get_u16",

     &ConfigObject::get_value_pybind<uint16_t>, "Simple getter function", py::arg("attr"))

    .def("get_s32",

     &ConfigObject::get_value_pybind<int32_t>, "Simple getter function", py::arg("attr"))

    .def("get_u32",

     &ConfigObject::get_value_pybind<uint32_t>, "Simple getter function", py::arg("attr"))

    .def("get_s64",

     &ConfigObject::get_value_pybind<int64_t>, "Simple getter function", py::arg("attr"))

    .def("get_u64",

     &ConfigObject::get_value_pybind<uint64_t>, "Simple getter function", py::arg("attr"))

    .def("get_float",

     &ConfigObject::get_value_pybind<float>, "Simple getter function", py::arg("attr"))

    .def("get_double",

     &ConfigObject::get_value_pybind<double>, "Simple getter function", py::arg("attr"))

    .def("get_string_vec",

     &ConfigObject::get_list_pybind<std::string>, "Getter function for a list", py::arg("attr"))

    .def("get_bool_vec",

     &ConfigObject::get_list_pybind<bool>, "Getter function for a list", py::arg("attr"))

    .def("get_s8_vec",

     &ConfigObject::get_list_pybind<int8_t>, "Getter function for a list", py::arg("attr"))

    .def("get_u8_vec",

     &ConfigObject::get_list_pybind<uint8_t>, "Getter function for a list", py::arg("attr"))

    .def("get_s16_vec",

     &ConfigObject::get_list_pybind<int16_t>, "Getter function for a list", py::arg("attr"))

    .def("get_u16_vec",

     &ConfigObject::get_list_pybind<uint16_t>, "Getter function for a list", py::arg("attr"))

    .def("get_s32_vec",

     &ConfigObject::get_list_pybind<int32_t>, "Getter function for a list", py::arg("attr"))

    .def("get_u32_vec",

     &ConfigObject::get_list_pybind<uint32_t>, "Getter function for a list", py::arg("attr"))

    .def("get_s64_vec",

     &ConfigObject::get_list_pybind<int64_t>, "Getter function for a list", py::arg("attr"))

    .def("get_u64_vec",

     &ConfigObject::get_list_pybind<uint64_t>, "Getter function for a list", py::arg("attr"))

    .def("get_float_vec",

     &ConfigObject::get_list_pybind<float>, "Getter function for a list", py::arg("attr"))

    .def("get_double_vec",

     &ConfigObject::get_list_pybind<double>, "Getter function for a list", py::arg("attr"))

    .def("rename",

     &ConfigObject::rename, "Rename object", py::arg("new_id"))

    .def("set_obj",

     &ConfigObject::set_obj, "Set relationship single-value", py::arg("name"), py::arg("o"), py::arg("skip_non_null_check") = false)

    .def("set_objs",

     &ConfigObject::set_objs, "Set relationship multi-value.", py::arg("name"), py::arg("o"), py::arg("skip_non_null_check") = false)

    .def("set_class",

     py::overload_cast<const std::string&, const std::string&>(&ConfigObject::set_class), "Set the class name", py::arg("name"), py::arg("value"))

    .def("set_date",

     py::overload_cast<const std::string&, const std::string&>(&ConfigObject::set_date), "Set the date", py::arg("name"), py::arg("value"))

    .def("set_enum",

     py::overload_cast<const std::string&, const std::string&>(&ConfigObject::set_enum), "Set the enum", py::arg("name"), py::arg("value"))

    .def("set_string",

     &ConfigObject::set_by_val<std::string>, "Simple setter function", py::arg("name"), py::arg("value"))

    .def("set_time",

     py::overload_cast<const std::string&, const std::string&>(&ConfigObject::set_time), "Set the time", py::arg("name"), py::arg("value"))

    .def("set_bool",

     &ConfigObject::set_by_val<bool>, "Simple setter function", py::arg("name"), py::arg("value"))

    .def("set_s8",

     &ConfigObject::set_by_val<int8_t>, "Simple setter function", py::arg("name"), py::arg("value"))

    .def("set_u8",

     &ConfigObject::set_by_val<uint8_t>, "Simple setter function", py::arg("name"), py::arg("value"))

    .def("set_s16",

     &ConfigObject::set_by_val<int16_t>, "Simple setter function", py::arg("name"), py::arg("value"))

    .def("set_u16",

     &ConfigObject::set_by_val<uint16_t>, "Simple setter function", py::arg("name"), py::arg("value"))

    .def("set_s32",

     &ConfigObject::set_by_val<int32_t>, "Simple setter function", py::arg("name"), py::arg("value"))

    .def("set_u32",

     &ConfigObject::set_by_val<uint32_t>, "Simple setter function", py::arg("name"), py::arg("value"))

    .def("set_s64",

     &ConfigObject::set_by_val<int64_t>, "Simple setter function", py::arg("name"), py::arg("value"))

    .def("set_u64",

     &ConfigObject::set_by_val<uint64_t>, "Simple setter function", py::arg("name"), py::arg("value"))

    .def("set_float",

     &ConfigObject::set_by_val<float>, "Simple setter function", py::arg("name"), py::arg("value"))

    .def("set_double",

     &ConfigObject::set_by_val<double>, "Simple setter function", py::arg("name"), py::arg("value"))

    .def("set_bool_vec",

     &ConfigObject::set_list_pybind<bool>, "Setter function for list", py::arg("attrname"), py::arg("l"))

    .def("set_s8_vec",

     &ConfigObject::set_list_pybind<int8_t>, "Setter function for list", py::arg("attrname"), py::arg("l"))

    .def("set_u8_vec",

     &ConfigObject::set_list_pybind<uint8_t>, "Setter function for list", py::arg("attrname"), py::arg("l"))

    .def("set_s16_vec",

     &ConfigObject::set_list_pybind<int16_t>, "Setter function for list", py::arg("attrname"), py::arg("l"))

    .def("set_u16_vec",

     &ConfigObject::set_list_pybind<uint16_t>, "Setter function for list", py::arg("attrname"), py::arg("l"))

    .def("set_s32_vec",

     &ConfigObject::set_list_pybind<int32_t>, "Setter function for list", py::arg("attrname"), py::arg("l"))

    .def("set_u32_vec",

     &ConfigObject::set_list_pybind<uint32_t>, "Setter function for list", py::arg("attrname"), py::arg("l"))

    .def("set_s64_vec",

     &ConfigObject::set_list_pybind<int64_t>, "Setter function for list", py::arg("attrname"), py::arg("l"))

    .def("set_u64_vec",

     &ConfigObject::set_list_pybind<uint64_t>, "Setter function for list", py::arg("attrname"), py::arg("l"))

    .def("set_float_vec",

     &ConfigObject::set_list_pybind<float>, "Setter function for list", py::arg("attrname"), py::arg("l"))

    .def("set_double_vec",

     &ConfigObject::set_list_pybind<double>, "Setter function for list", py::arg("attrname"), py::arg("l"))

    .def("set_class_vec",

     &ConfigObject::set_list_pybind<std::string>, "Set list of classes", py::arg("attrname"), py::arg("l"))

    .def("set_date_vec",

     &ConfigObject::set_list_pybind<std::string>, "Set list of dates", py::arg("attrname"), py::arg("l"))

    .def("set_enum_vec",

     &ConfigObject::set_list_pybind<std::string>, "Set list of enums", py::arg("attrname"), py::arg("l"))

    .def("set_string_vec",

     &ConfigObject::set_list_pybind<std::string>, "Set list of strings", py::arg("attrname"), py::arg("l"))

    .def("set_time_vec",

     &ConfigObject::set_list_pybind<std::string>, "Set list of times", py::arg("attrname"), py::arg("l"))

    .def("UID",

     &ConfigObject::UID, "Return object identity")

    ;


}


} // namespace dunedaq::conffwk::python

ConfigObject.hpp

dunedaq::conffwk::ConfigObject::set_time
void set_time(const std::string &name, const std::string &value)
Set attribute time value.
Definition ConfigObject.hpp:480

dunedaq::conffwk::ConfigObject::set_by_val
void set_by_val(const std::string &name, T value)
Set attribute value.
Definition ConfigObject.hpp:391

dunedaq::conffwk::ConfigObject::get_obj_pybind
ConfigObject * get_obj_pybind(const std::string &attrname)
Definition ConfigObject.cpp:297

dunedaq::conffwk::ConfigObject::get_value_pybind
T get_value_pybind(const std::string &attrname)
Definition ConfigObject.hpp:117

dunedaq::conffwk::ConfigObject::set_date
void set_date(const std::string &name, const std::string &value)
Set attribute date value.
Definition ConfigObject.hpp:463

dunedaq::conffwk::ConfigObject::set_objs
void set_objs(const std::string &name, const std::vector< const ConfigObject * > &o, bool skip_non_null_check=false)
Set relationship multi-value.
Definition ConfigObject.hpp:365

dunedaq::conffwk::ConfigObject::UID
const std::string & UID() const noexcept
Return object identity.
Definition ConfigObject.hpp:218

dunedaq::conffwk::ConfigObject::set_class
void set_class(const std::string &name, const std::string &value)
Set attribute class value.
Definition ConfigObject.hpp:446

dunedaq::conffwk::ConfigObject::set_list_pybind
void set_list_pybind(const std::string &attrname, std::vector< T > l)
Definition ConfigObject.hpp:131

dunedaq::conffwk::ConfigObject::set_enum
void set_enum(const std::string &name, const std::string &value)
Set attribute enumeration value.
Definition ConfigObject.hpp:429

dunedaq::conffwk::ConfigObject::full_name
const std::string full_name() const noexcept
Return full object name.
Definition ConfigObject.hpp:241

dunedaq::conffwk::ConfigObject::set_obj
void set_obj(const std::string &name, const ConfigObject *o, bool skip_non_null_check=false)
Set relationship single-value.
Definition ConfigObject.hpp:349

dunedaq::conffwk::ConfigObject::rename
void rename(const std::string &new_id)
Rename object.
Definition ConfigObject.cpp:87

dunedaq::conffwk::ConfigObject::get_list_pybind
std::vector< T > get_list_pybind(const std::string &attrname)
Definition ConfigObject.hpp:124

dunedaq::conffwk::ConfigObject::class_name
const std::string & class_name() const noexcept
Return object's class name.
Definition ConfigObject.hpp:231

dunedaq::conffwk::ConfigObject::contained_in
const std::string contained_in() const
Return the name of the database file this object belongs to.
Definition ConfigObject.hpp:249

dunedaq::conffwk::Configuration
Defines base class for cache of template objects.
Definition Configuration.hpp:221

dunedaq::conffwk::Configuration::get_objs_pybind
std::vector< ConfigObject > * get_objs_pybind(const std::string &class_name, const std::string &query="")
Definition Configuration.cpp:2063

dunedaq::conffwk::Configuration::attributes_pybind
std::unordered_map< std::string, std::unordered_map< std::string, std::string > > attributes_pybind(const std::string &class_name, bool all)
Definition Configuration.cpp:1999

dunedaq::conffwk::Configuration::destroy_obj
void destroy_obj(ConfigObject &object)
Destroy object.
Definition Configuration.cpp:824

dunedaq::conffwk::Configuration::relations_pybind
std::unordered_map< std::string, std::unordered_map< std::string, std::string > > relations_pybind(const std::string &class_name, bool all)
Definition Configuration.cpp:2071

dunedaq::conffwk::Configuration::remove_include
void remove_include(const std::string &db_name, const std::string &include)
Remove include file.
Definition Configuration.cpp:497

dunedaq::conffwk::Configuration::load
void load(const std::string &db_name)
Load database according to the name. If name is empty, take it from TDAQ_DB_NAME and TDAQ_DB_DATA env...
Definition Configuration.cpp:304

dunedaq::conffwk::Configuration::get_impl_param
const std::string & get_impl_param() const noexcept
Definition Configuration.hpp:264

dunedaq::conffwk::Configuration::superclasses_pybind
std::vector< std::string > superclasses_pybind(const std::string &class_name, bool all)
Definition Configuration.cpp:2107

dunedaq::conffwk::Configuration::create
void create(const std::string &at, const std::string &class_name, const std::string &id, ConfigObject &object)
Create new object by class name and object id.
Definition Configuration.cpp:791

dunedaq::conffwk::Configuration::subclasses_pybind
std::vector< std::string > subclasses_pybind(const std::string &class_name, bool all)
Definition Configuration.cpp:2100

dunedaq::conffwk::Configuration::return_includes_pybind
std::list< std::string > * return_includes_pybind(const std::string &db_name)
Definition Configuration.cpp:2093

dunedaq::conffwk::Configuration::loaded
bool loaded() const noexcept
Check if database is correctly loaded.
Definition Configuration.cpp:298

dunedaq::conffwk::Configuration::get_class_list
std::vector< std::string > get_class_list() const
Definition Configuration.cpp:2026

dunedaq::conffwk::Configuration::get_schema_path_pybind
const std::string & get_schema_path_pybind(const std::string &class_name)
Definition Configuration.cpp:2114

dunedaq::conffwk::Configuration::get_impl_spec
const std::string & get_impl_spec() const noexcept
Definition Configuration.hpp:254

dunedaq::conffwk::Configuration::commit
void commit(const std::string &log_message="")
Commit database changes.
Definition Configuration.cpp:580

dunedaq::conffwk::Configuration::get_obj_pybind
ConfigObject * get_obj_pybind(const std::string &class_name, const std::string &id)
Definition Configuration.cpp:2051

dunedaq::conffwk::Configuration::unload
void unload()
Unload database.
Definition Configuration.cpp:368

dunedaq::conffwk::Configuration::test_object
bool test_object(const std::string &class_name, const std::string &id, unsigned long rlevel=0, const std::vector< std::string > *rclasses=0)
Test the object existence.
Definition Configuration.cpp:775

dunedaq::conffwk::Configuration::add_include
void add_include(const std::string &db_name, const std::string &include)
Add include file to existing database.
Definition Configuration.cpp:474

dunedaq::conffwk::Configuration::create_and_return_obj_pybind
ConfigObject * create_and_return_obj_pybind(const std::string &at, const std::string &class_name, const std::string &id)
Definition Configuration.cpp:2036

Configuration.hpp
conffwk entry point

Schema.hpp

dunedaq::conffwk::python
Definition ConfigurationPointer.hpp:17

dunedaq::conffwk::python::register_conffwk
void register_conffwk(py::module &m)
Definition config.cpp:27

dunedaq::conffwk::python::register_conffwkobject
void register_conffwkobject(py::module &m)
Definition config.cpp:82

set.hpp