From 309b215e18f15eb0090fc8a38bfd003c6c906838 Mon Sep 17 00:00:00 2001
From: Octave Perrin <operrin@lrtechnologies.fr>
Date: Thu, 28 Nov 2024 15:50:26 +0100
Subject: [PATCH] back to graphview
---
python_binding/graph/pybind_GraphView.cpp | 31 ++++++++++++++++++-----
1 file changed, 25 insertions(+), 6 deletions(-)
diff --git a/python_binding/graph/pybind_GraphView.cpp b/python_binding/graph/pybind_GraphView.cpp
index 831f8c6c7..ce425b8d4 100644
--- a/python_binding/graph/pybind_GraphView.cpp
+++ b/python_binding/graph/pybind_GraphView.cpp
@@ -76,32 +76,51 @@ void init_GraphView(py::module& m) {
.def("set_root_node", &GraphView::setRootNode, py::arg("node"),
R"mydelimiter(
- TODO
+ Changes the rootNode of the GraphView
+ :param node: The Node of the GraphView that will become the new rootNode
+ :type node: Node
)mydelimiter")
.def("__repr__", &GraphView::repr,
R"mydelimiter(
- TODO
+ returns information about the graphView: its name, number of nodes, of inputs and of outputs.
+ :return: a chain of caracter describing the graphView
+ :rtype: string
)mydelimiter")
.def("__len__", [](const GraphView& g){ return g.getNodes().size(); },
R"mydelimiter(
- TODO
+ returns the number of Nodes of the GraphView
+ :param g: The observed graphView
+ :type g: graphView
+ :return: the number of Nodes of the graphView g
+ :rtype: int
)mydelimiter")
.def("log_outputs", &GraphView::logOutputs, py::arg("path"),
R"mydelimiter(
- TODO
+ Logs the output of all nodes of the graph in a directory
+ In the specified directory, it will create a subdirectory for each Node of the GraphView
+ In that sub-directory, each output of the Node will be saved in a different .log file
+
+ :param path: The path to the folder where we wish to stock the logs
+ :type path: string
)mydelimiter")
.def("get_ordered_inputs", &GraphView::getOrderedInputs,
R"mydelimiter(
- TODO
+ Get inputs of the current GraphView with their associated id.
+ The rank of the nodes are their rank in the vector.
+ :return: The pairs Node, inputId of each input of the graphView
+ :rtype: List[(Node, int)]
)mydelimiter")
.def("get_ordered_outputs", &GraphView::getOrderedOutputs,
R"mydelimiter(
- TODO
+ Get outputs of the current GraphView with their associated id.
+ The rank of the nodes are their rank in the vector.
+ :return: The pairs Node, outputId of each output of the graphView
+ :rtype: List[(Node, int)]
)mydelimiter")
.def("get_output_nodes", &GraphView::outputNodes,
--
GitLab