gate.cpp

Go to the documentation of this file.

#include "hal_core/python_bindings/python_bindings.h"
 
namespace hal
{
    void gate_init(py::module& m)
    {
        py::class_<Gate, DataContainer, RawPtrWrapper<Gate>> py_gate(m, "Gate", R"(Gate class containing information about a gate including its location, functions, and module.)");
 
        py_gate.def(py::self == py::self, R"(
            Check whether two gates are equal.
            Does not check for connected nets or containing module.
 
            :returns: True if both gates are equal, false otherwise.
            :rtype: bool
        )");
 
        py_gate.def(py::self != py::self, R"(
            Check whether two gates are unequal.
            Does not check for connected nets or containing module.
 
            :returns: True if both gates are unequal, false otherwise.
            :rtype: bool
        )");
 
        py_gate.def("__hash__", &Gate::get_hash, R"(
            Python requires hash for set and dict container.
 
            :returns: The hash.
            :rtype: Py_hash_t
        )");
 
        py_gate.def_property_readonly("id", &Gate::get_id, R"(
            The unique ID of the gate.
 
            :type: int
        )");
 
        py_gate.def("get_id", &Gate::get_id, R"(
            Get the unique ID of the gate.
 
            :returns: The unique id.
            :type: int
        )");
 
        py_gate.def_property_readonly("netlist", [](Gate* g) { return RawPtrWrapper<Netlist>(g->get_netlist()); }, R"(
            The netlist this gate is associated with.
 
            :type: hal_py.Netlist
        )");
 
        py_gate.def("get_netlist", [](Gate* g) { return RawPtrWrapper<Netlist>(g->get_netlist()); }, R"(
            Get the netlist this gate is associated with.
 
            :returns: The netlist.
            :rtype: hal_py.Netlist
        )");
 
        py_gate.def_property("name", &Gate::get_name, &Gate::set_name, R"(
            The name of the gate.
 
            :type: str
        )");
 
        py_gate.def("get_name", &Gate::get_name, R"(
            Get the name of the gate.
 
            :returns: The name.
            :rtype: str
        )");
 
        py_gate.def("set_name", &Gate::set_name, py::arg("name"), R"(
            Set the name of the gate.
 
            :param str name: The new name.
        )");
 
        py_gate.def_property_readonly("type", &Gate::get_type, R"(
            The type of the gate
 
            :type: hal_py.Gate_type
        )");
 
        py_gate.def("get_type", &Gate::get_type, R"(
            Get the type of the gate.
 
            :returns: The gate's type.
            :rtype: hal_py.Gate_type
        )");
 
        py_gate.def("has_location", &Gate::has_location, R"(
            Checks whether the gate's location in the layout is available.
 
            :returns: True if valid location data is available, false otherwise.
            :rtype: bool
        )");
 
        py_gate.def_property("location_x", &Gate::get_location_x, &Gate::set_location_x, R"(
            The x-coordinate of the physical location of the gate in the layout. Only positive values are valid, negative values will be regarded as no location assigned.
 
            :type: int
        )");
 
        py_gate.def("get_location_x", &Gate::get_location_x, R"(
            Get the physical location x-coordinate of the gate in the layout.
            If no valid physical location x-coordinate is assigned, a negative value is returned.
 
            :returns: The gate's x-coordinate.
            :rtype: int
        )");
 
        py_gate.def("set_location_x", &Gate::set_location_x, py::arg("x"), R"(
            Set the physical location x-coordinate of the gate in the layout.
            Only positive values are valid, negative values will be regarded as no location assigned.
 
            :param int x: The gate's x-coordinate.
        )");
 
        py_gate.def_property("location_y", &Gate::get_location_y, &Gate::set_location_y, R"(
            The y-coordinate of the physical location of the gate in the layout.
            Only positive values are valid, negative values will be regarded as no location assigned.
 
            :type: int
        )");
 
        py_gate.def("get_location_y", &Gate::get_location_y, R"(
            Get the physical location y-coordinate of the gate in the layout.
            If no valid physical location y-coordinate is assigned, a negative value is returned.
 
            :returns: The gate's y-coordinate.
            :rtype: int
        )");
 
        py_gate.def("set_location_y", &Gate::set_location_y, py::arg("y"), R"(
            Set the physical location y-coordinate of the gate in the layout.
            Only positive values are valid, negative values will be regarded as no location assigned.
 
            :param int y: The gate's y-coordinate.
        )");
 
        py_gate.def_property("location", &Gate::get_location, &Gate::set_location, R"(
            The physical location of the gate in the layout.
            Only positive values are valid, negative values will be regarded as no location assigned.
 
            :type: tuple(int,int)
        )");
 
        py_gate.def("get_location", &Gate::get_location, R"(
            Get the physical location of the gate in the layout.
            If no valid physical location coordinate is assigned, a negative value is returned for the respective coordinate.
 
            :returns: A tuple <x-coordinate, y-coordinate>.
            :rtype: tuple(int,int)
        )");
 
        py_gate.def("set_location", &Gate::set_location, py::arg("location"), R"(
            Set the physical location of the gate in the layout.
            Only positive coordinates are valid, negative values will be regarded as no location assigned.
 
            :param tuple(int,int) location: A tuple <x-coordinate, y-coordinate>.
        )");
 
        py_gate.def_property_readonly("module", &Gate::get_module, R"(
            The module in which contains this gate.
 
            :type: hal_py.Module
        )");
 
        py_gate.def("get_module", &Gate::get_module, R"(
            Get the module which contains this gate.
 
            :returns: The module.
            :rtype: hal_py.Module
        )");
 
        py_gate.def_property_readonly("modules", [](Gate* g) { return g->get_modules(); }, R"(
            A list of all modules that contain this gate, either directly or as parent of another module.
 
            :type: list[hal_py.Module]
        )");
 
        py_gate.def("get_modules", &Gate::get_modules, py::arg("filter") = nullptr, py::arg("recursive") = true, R"(
            Get all modules that contain this gate, either directly or as parent of another module.
            If recursive is set to True, indirect parent modules are also included. Otherwise, only the module containing the gate directly is returned.
            The optional filter is evaluated on every candidate such that the result only contains those matching the specified condition.
 
            :param lambda filter: An optional filter.
            :param bool recursive: Set True to include indirect parents as well, False otherwise.
            :returns: A list of modules.
            :rtype: list[hal_py.Module]
        )");
 
        py_gate.def("get_grouping", &Gate::get_grouping, R"(
            Gets the grouping in which this gate is contained.
            If no grouping contains this gate, *None* is returned.
 
            :returns: The grouping.
            :rtype: hal_py.Grouping
        )");
 
        py_gate.def("get_boolean_function", py::overload_cast<const std::string&>(&Gate::get_boolean_function, py::const_), py::arg("name"), R"(
            Get the Boolean function specified by the given name.
            This name can for example be an output pin of the gate or any other user-defined function name.
 
            :param str name: The name.
            :returns: The Boolean function on success, an empty Boolean function otherwise.
            :rtype: hal_py.BooleanFunction
        )");
 
        py_gate.def("get_boolean_function", py::overload_cast<const GatePin*>(&Gate::get_boolean_function, py::const_), py::arg("pin") = nullptr, R"(
            Get the Boolean function corresponding to the given output pin.
            If pin is None, the Boolean function of the first output pin is returned.
 
            :param hal_py.GatePin pin: The pin.
            :returns: The Boolean function on success, an empty Boolean function otherwise.
            :rtype: hal_py.BooleanFunction
        )");
 
        py_gate.def(
            "get_resolved_boolean_function",
            [](const Gate& self, const GatePin* pin, const bool use_net_variables = false) -> std::optional<BooleanFunction> {
                auto res = self.get_resolved_boolean_function(pin, use_net_variables);
                if (res.is_ok())
                {
                    return res.get();
                }
                else
                {
                    log_error("python_context", "{}", res.get_error().get());
                    return std::nullopt;
                }
            },
            py::arg("pin"),
            py::arg("use_net_variables") = false,
            R"(
            Get the resolved Boolean function corresponding to the given output pin, i.e., a Boolean function that only depends on input pins (or nets) and no internal or output pins.
            If fan-in nets are used to derive variable names, the variable names are generated using the ``BooleanFunctionNetDecorator``.
 
            :param hal_py.GatePin pin: The output pin.
            :param bool use_net_variables: Set ``True`` to use variable names derived from fan-in nets of the gate, ``False`` to use input pin names instead. Defaults to ``False``.
            :returns: The Boolean function on success, ``None`` otherwise.
            :rtype: hal_py.BooleanFunction or None
        )");
 
        py_gate.def_property_readonly("boolean_functions", [](Gate* g) { return g->get_boolean_functions(); }, R"(
            A dictionary from function name to Boolean function for all boolean functions associated with this gate.
 
            :rtype: dict[str,hal_py.BooleanFunction]
        )");
 
        py_gate.def("get_boolean_functions", &Gate::get_boolean_functions, py::arg("only_custom_functions") = false, R"(
            Get a dictionary from function name to Boolean function for all boolean functions associated with this gate.
 
            :param bool only_custom_functions: If true, this returns only the functions which were set via :func:`add_boolean_function`.
            :returns: A map from function name to function.
            :rtype: dict[str,hal_py.BooleanFunction]
        )");
 
        py_gate.def("add_boolean_function", &Gate::add_boolean_function, py::arg("name"), py::arg("func"), R"(
            Add a Boolean function with the given name to the gate.
 
            :param str name: The name.
            :param hal_py.BooleanFunction func:  The function.
            :returns: True on success, False otherwise.
            :rtype: bool
        )");
 
        py_gate.def("mark_vcc_gate", &Gate::mark_vcc_gate, R"(
            Mark this gate as a global vcc gate.
 
            :returns: True on success, False otherwise.
            :rtype: bool
        )");
 
        py_gate.def("mark_gnd_gate", &Gate::mark_gnd_gate, R"(
            Mark this gate as a global gnd gate.
 
            :returns: True on success, False otherwise.
            :rtype: bool
        )");
 
        py_gate.def("unmark_vcc_gate", &Gate::unmark_vcc_gate, R"(
            Unmark this gate as a global vcc gate.
 
            :returns: True on success, False otherwise.
            :rtype: bool
        )");
 
        py_gate.def("unmark_gnd_gate", &Gate::unmark_gnd_gate, R"(
            Unmark this gate as a global gnd gate.
 
            :returns: True on success, False otherwise.
            :rtype: bool
        )");
 
        py_gate.def("is_vcc_gate", &Gate::is_vcc_gate, R"(
            Checks whether this gate is a global vcc gate.
 
            :returns: True if the gate is a global vcc gate, False otherwise.
            :rtype: bool
        )");
 
        py_gate.def("is_gnd_gate", &Gate::is_gnd_gate, R"(
            Checks whether this gate is a global gnd gate.
 
            :returns: True if the gate is a global gnd gate, False otherwise.
            :rtype: bool
        )");
 
        py_gate.def_property_readonly("fan_in_nets", py::overload_cast<>(&Gate::get_fan_in_nets, py::const_), R"(
            A list of all fan-in nets of the gate, i.e., all nets that are connected to one of the input pins.
 
            :type: list[hal_py.Net]
        )");
 
        py_gate.def("get_fan_in_nets", py::overload_cast<>(&Gate::get_fan_in_nets, py::const_), R"(
            Get a list of all fan-in nets of the gate, i.e., all nets that are connected to one of the input pins.
 
            :returns: A list of all fan-in nets.
            :rtype: list[hal_py.Net]
        )");
 
        py_gate.def("get_fan_in_nets", py::overload_cast<const std::function<bool(Net*)>&>(&Gate::get_fan_in_nets, py::const_), py::arg("filter"), R"(
            Get a list of all fan-in nets of the gate, i.e., all nets that are connected to one of the input pins.
            The filter is evaluated on every candidate such that the result only contains those matching the specified condition.
 
            :param lambda filter: Filter function to be evaluated on each net.
            :returns: A list of all fan-in nets.
            :rtype: list[hal_py.Net]
        )");
 
        py_gate.def("get_fan_in_net", py::overload_cast<const std::string&>(&Gate::get_fan_in_net, py::const_), py::arg("pin_name"), R"(
            Get the fan-in net corresponding to the input pin specified by name.
 
            :param str pin_name: The input pin name.
            :returns: The fan-in net on success, None otherwise.
            :rtype: hal_py.Net or None
        )");
 
        py_gate.def("get_fan_in_net", py::overload_cast<const GatePin*>(&Gate::get_fan_in_net, py::const_), py::arg("pin"), R"(
            Get the fan-in net corresponding to the specified input pin.
 
            :param hal_py.GatePin pin: The input pin.
            :returns: The fan-in net on success, None otherwise.
            :rtype: hal_py.Net or None
        )");
 
        py_gate.def("is_fan_in_net", &Gate::is_fan_in_net, py::arg("net"), R"(
            Check whether the given net is a fan-in of the gate.
 
            :param hal_py.Net net: The net.
            :returns: True if the net is a fan-in of the gate, False otherwise. 
            :rtype: bool
        )");
 
        py_gate.def_property_readonly("fan_in_endpoints", py::overload_cast<>(&Gate::get_fan_in_endpoints, py::const_), R"(
            A list of all fan-in endpoints of the gate, i.e., all endpoints associated with an input pin of the gate.
 
            :type: list[hal_py.Endpoint]
        )");
 
        py_gate.def("get_fan_in_endpoints", py::overload_cast<>(&Gate::get_fan_in_endpoints, py::const_), R"(
            Get a list of all fan-in endpoints of the gate, i.e., all endpoints associated with an input pin of the gate.
 
            :returns: A list of all fan-in endpoints.
            :rtype: list[hal_py.Endpoint]
        )");
 
        py_gate.def("get_fan_in_endpoints", py::overload_cast<const std::function<bool(Endpoint*)>&>(&Gate::get_fan_in_endpoints, py::const_), py::arg("filter"), R"(
            Get a list of all fan-in endpoints of the gate, i.e., all endpoints associated with an input pin of the gate.
            The filter is evaluated on every candidate such that the result only contains those matching the specified condition.
 
            :param lambda filter: Filter function to be evaluated on each endpoint.
            :returns: A list of all fan-in endpoints.
            :rtype: list[hal_py.Endpoint]
        )");
 
        py_gate.def("get_fan_in_endpoint", py::overload_cast<const std::string&>(&Gate::get_fan_in_endpoint, py::const_), py::arg("pin_name"), R"(
            Get the fan-in endpoint corresponding to the input pin specified by name.
 
            :param str pin_name: The input pin name.
            :returns: The endpoint on success, None otherwise.
            :rtype: hal_py.Endpoint or None
        )");
 
        py_gate.def("get_fan_in_endpoint", py::overload_cast<const GatePin*>(&Gate::get_fan_in_endpoint, py::const_), py::arg("pin"), R"(
            Get the fan-in endpoint corresponding to the specified input pin.
 
            :param hal_py.GatePin pin: The input pin.
            :returns: The endpoint on success, None otherwise.
            :rtype: hal_py.Endpoint or None
        )");
 
        py_gate.def("get_fan_in_endpoint", py::overload_cast<const Net*>(&Gate::get_fan_in_endpoint, py::const_), py::arg("net"), R"(
            Get the fan-in endpoint connected to the specified input net.
 
            :param hal_py.Net net: The input net.
            :returns: The endpoint on success, None otherwise.
            :rtype: hal_py.Endpoint or None
        )");
 
        py_gate.def_property_readonly("fan_out_nets", py::overload_cast<>(&Gate::get_fan_out_nets, py::const_), R"(
            A list of all fan-out nets of the gate, i.e., all nets that are connected to one of the output pins.
 
            :type: list[hal_py.Net]
        )");
 
        py_gate.def("get_fan_out_nets", py::overload_cast<>(&Gate::get_fan_out_nets, py::const_), R"(
            Get a list of all fan-out nets of the gate, i.e., all nets that are connected to one of the output pins.
 
            :returns: A list of all fan-out nets.
            :rtype: list[hal_py.Net]
        )");
 
        py_gate.def("get_fan_out_nets", py::overload_cast<const std::function<bool(Net*)>&>(&Gate::get_fan_out_nets, py::const_), py::arg("filter"), R"(
            Get a list of all fan-out nets of the gate, i.e., all nets that are connected to one of the output pins.
            The filter is evaluated on every candidate such that the result only contains those matching the specified condition.
 
            :param lambda filter: Filter function to be evaluated on each net.
            :returns: A list of all fan-out nets.
            :rtype: list[hal_py.Net]
        )");
 
        py_gate.def("get_fan_out_net", py::overload_cast<const std::string&>(&Gate::get_fan_out_net, py::const_), py::arg("pin_name"), R"(
            Get the fan-out net corresponding to the output pin specified by name.
 
            :param str pin_name: The output pin name.
            :returns: The fan-out net on success, None otherwise.
            :rtype: hal_py.Net or None
        )");
 
        py_gate.def("get_fan_out_net", py::overload_cast<const GatePin*>(&Gate::get_fan_out_net, py::const_), py::arg("pin"), R"(
            Get the fan-out net corresponding to the specified output pin.
 
            :param hal_py.GatePin pin: The output pin.
            :returns: The fan-out net on success, None otherwise.
            :rtype: hal_py.Net or None
        )");
 
        py_gate.def("is_fan_out_net", &Gate::is_fan_out_net, py::arg("net"), R"(
            Check whether the given net is a fan-out of the gate.
 
            :param hal_py.Net net: The net.
            :returns: True if the net is a fan-out of the gate, False otherwise. 
            :rtype: bool
        )");
 
        py_gate.def_property_readonly("fan_out_endpoints", py::overload_cast<>(&Gate::get_fan_out_endpoints, py::const_), R"(
            A list of all fan-out endpoints of the gate, i.e., all endpoints associated with an output pin of the gate.
 
            :type: list[hal_py.Endpoint]
        )");
 
        py_gate.def("get_fan_out_endpoints", py::overload_cast<>(&Gate::get_fan_out_endpoints, py::const_), R"(
            Get a list of all fan-out endpoints of the gate, i.e., all endpoints associated with an output pin of the gate.
 
            :returns: A list of all fan-out endpoints.
            :rtype: list[hal_py.Endpoint]
        )");
 
        py_gate.def("get_fan_out_endpoints", py::overload_cast<const std::function<bool(Endpoint*)>&>(&Gate::get_fan_out_endpoints, py::const_), py::arg("filter"), R"(
            Get a list of all fan-out endpoints of the gate, i.e., all endpoints associated with an output pin of the gate.
            The filter is evaluated on every candidate such that the result only contains those matching the specified condition.
 
            :param lambda filter: Filter function to be evaluated on each endpoint.
            :returns: A list of all fan-out endpoints.
            :rtype: list[hal_py.Endpoint]
        )");
 
        py_gate.def("get_fan_out_endpoint", py::overload_cast<const std::string&>(&Gate::get_fan_out_endpoint, py::const_), py::arg("pin_name"), R"(
            Get the fan-out endpoint corresponding to the output pin specified by name.
 
            :param str pin_name: The output pin name.
            :returns: The endpoint on success, None otherwise.
            :rtype: hal_py.Endpoint or None
        )");
 
        py_gate.def("get_fan_out_endpoint", py::overload_cast<const GatePin*>(&Gate::get_fan_out_endpoint, py::const_), py::arg("pin"), R"(
            Get the fan-out endpoint corresponding to the specified output pin.
 
            :param hal_py.GatePin pin: The output pin.
            :returns: The endpoint on success, None otherwise.
            :rtype: hal_py.Endpoint or None
        )");
 
        py_gate.def("get_fan_out_endpoint", py::overload_cast<const Net*>(&Gate::get_fan_out_endpoint, py::const_), py::arg("net"), R"(
            Get the fan-out endpoint connected to the specified output net.
 
            :param hal_py.Net net: The output net.
            :returns: The endpoint on success, None otherwise.
            :rtype: hal_py.Endpoint or None
        )");
 
        py_gate.def_property_readonly("unique_predecessors", [](Gate* g) { return g->get_unique_predecessors(); }, R"(
            A list of all unique predecessor gates of the gate.
 
            :type: list[hal_py.Gate]
        )");
 
        py_gate.def("get_unique_predecessors", &Gate::get_unique_predecessors, py::arg("filter") = nullptr, R"(
            Get a list of all unique predecessor gates of the gate.
            The optional filter is evaluated on every candidate such that the result only contains those matching the specified condition.
 
            :param lambda filter: An optional filter being evaluated on the gate's input pin as well as the predecessor endpoint.
            :returns: A list of unique predecessors endpoints.
            :rtype: list[hal_py.Gate]
        )");
 
        py_gate.def_property_readonly("predecessors", [](Gate* g) { return g->get_predecessors(); }, R"(
            A list of all direct predecessor endpoints of the gate, i.e., all predecessor endpoints that are connected to an input pin of the gate. 
 
            :type: list[hal_py.Endpoint]
        )");
 
        py_gate.def("get_predecessors", &Gate::get_predecessors, py::arg("filter") = nullptr, R"(
            Get a list of all direct predecessor endpoints of the gate, i.e., all predecessor endpoints that are connected to an input pin of the gate. 
            The optional filter is evaluated on every candidate such that the result only contains those matching the specified condition.
 
            :param lambda filter: An optional filter being evaluated on the gate's input pin as well as the predecessor endpoint.
            :returns: A list of predecessors endpoints.
            :rtype: list[hal_py.Endpoint]
        )");
 
        py_gate.def("get_predecessor", py::overload_cast<const std::string&>(&Gate::get_predecessor, py::const_), py::arg("pin_name"), R"(
            Get a single direct predecessor endpoint that is connected to the input pin specified by name.
            Fails if there are no or more than one predecessors.
 
            :param str pin_name: The input pin name.
            :returns: The predecessor endpoint on success, None otherwise.
            :rtype: hal_py.Endpoint or None
        )");
 
        py_gate.def("get_predecessor", py::overload_cast<const GatePin*>(&Gate::get_predecessor, py::const_), py::arg("pin"), R"(
            Get a single direct predecessor endpoint that is connected to the specified input pin.
            Fails if there are no or more than one predecessors.
 
            :param hal_py.GatePin pin: The input pin.
            :returns: The predecessor endpoint on success, None otherwise.
            :rtype: hal_py.Endpoint or None
        )");
 
        py_gate.def_property_readonly("unique_successors", [](Gate* g) { return g->get_unique_successors(); }, R"(
            A list of all unique successor gates of the gate.
 
            :type: list[hal_py.Gate]
        )");
 
        py_gate.def("get_unique_successors", &Gate::get_unique_successors, py::arg("filter") = nullptr, R"(
            Get a list of all unique successor gates of the gate.
            The optional filter is evaluated on every candidate such that the result only contains those matching the specified condition.
 
            :param lambda filter: An optional filter being evaluated on the gate's output pin as well as the successor endpoint.
            :returns: A list of unique successor endpoints.
            :rtype: list[hal_py.Gate]
        )");
 
        py_gate.def_property_readonly("successors", [](Gate* g) { return g->get_successors(); }, R"(
            A list of all direct successor endpoints of the gate, i.e., all successor endpoints that are connected to an output pin of the gate. 
 
            :type: list[hal_py.Endpoint]
        )");
 
        py_gate.def("get_successors", &Gate::get_successors, py::arg("filter") = nullptr, R"(
            Get a list of all direct successor endpoints of the gate, i.e., all successor endpoints that are connected to an output pin of the gate. 
            The optional filter is evaluated on every candidate such that the result only contains those matching the specified condition.
 
            :param lambda filter: An optional filter being evaluated on the gate's output pin as well as the successor endpoint.
            :returns: A list of successor endpoints.
            :rtype: list[hal_py.Endpoint]
        )");
 
        py_gate.def("get_successor", py::overload_cast<const std::string&>(&Gate::get_successor, py::const_), py::arg("pin_name"), R"(
            Get a single direct successor endpoint that is connected to the output pin specified by name.
            Fails if there are no or more than one successors.
 
            :param str pin_name: The output pin name.
            :returns: The successor endpoint on success, None otherwise.
            :rtype: hal_py.Endpoint or None
        )");
 
        py_gate.def("get_successor", py::overload_cast<const GatePin*>(&Gate::get_successor, py::const_), py::arg("pin"), R"(
            Get a single direct successor endpoint that is connected to the output pin specified by name.
            Fails if there are no or more than one successors.
 
            :param hal_py.GatePin pin: The output pin.
            :returns: The successor endpoint on success, None otherwise.
            :rtype: hal_py.Endpoint or None
        )");
 
        py_gate.def(
            "get_init_data",
            [](Gate& self) -> std::vector<std::string> {
                auto res = self.get_init_data();
                if (res.is_ok())
                {
                    return res.get();
                }
                else
                {
                    log_error("python_context", "error encountered while getting INIT data:\n{}", res.get_error().get());
                    return {};
                }
            },
            R"(
            Get the INIT data of the gate, if available. 
            An error is returned in case the gate does not hold any INIT data.
 
            :returns: The INIT data as a list on success, an empty list otherwise.
            :rtype: list[str]
        )");
 
        py_gate.def(
            "set_init_data",
            [](Gate& self, const std::vector<std::string>& init_data) -> bool {
                auto res = self.set_init_data(init_data);
                if (res.is_ok())
                {
                    return true;
                }
                else
                {
                    log_error("python_context", "error encountered while setting INIT data:\n{}", res.get_error().get());
                    return false;
                }
            },
            py::arg("init_data"),
            R"(
            Set the INIT data of the gate, if available.
            An error is returned in case the gate does not hold any INIT data.
 
            :param list[str] init_data: The INIT data as a list.
            :returns: True on success, False otherwise.
            :rtype: bool
        )");
    }
}    // namespace hal