GNode library (C++)
Loading...
Searching...
No Matches
node.hpp
Go to the documentation of this file.
1/* Copyright (c) 2023 Otto Link. Distributed under the terms of the GNU General
2 * Public License. The full license is in the file LICENSE, distributed with
3 * this software. */
4
15#pragma once
16#include <memory>
17#include <stdexcept>
18#include <vector>
19
20#include "gnode/data.hpp"
21#include "gnode/port.hpp"
22
23namespace gnode
24{
25
26class Graph; // forward
27
33class Node
34{
35public:
40 bool is_dirty = false;
41
45 Node() = default;
46
52 Node(std::string label) : label(label) {}
53
65 Node(std::string label, std::string id) : label(label), id(id) {}
66
70 virtual ~Node() = default;
71
88 template <typename T, typename... Args>
89 void add_port(PortType port_type,
90 const std::string &port_label,
91 Args &&...args)
92 {
93 if (port_type == PortType::IN)
94 this->ports.push_back(std::make_shared<gnode::Input<T>>(port_label));
95 else
96 this->ports.push_back(
97 std::make_shared<gnode::Output<T>>(port_label,
98 std::forward<Args>(args)...));
99 }
100
105 virtual void compute() = 0;
106
113 std::shared_ptr<BaseData> get_base_data(int port_index);
114
121 std::shared_ptr<BaseData> get_base_data(const std::string &port_label);
122
132 std::string get_data_type(int port_index) const;
133
139 std::string get_graph_id() const;
140
146 std::string get_label() const { return this->label; }
147
153 std::string get_id() const { return this->id; }
154
160 int get_nports() const;
161
168 int get_nports(PortType port_type) const;
169
176 std::shared_ptr<BaseData> get_output_data(int port_index) const;
177
183 Graph *get_p_graph() const { return this->p_graph; }
184
191 int get_port_index(const std::string &port_label) const;
192
199 std::string get_port_label(int port_index) const;
200
207 PortType get_port_type(const std::string &port_label) const;
208
212 const std::vector<std::shared_ptr<Port>> &get_ports() { return this->ports; };
213
223 template <typename T> T *get_value_ref(const std::string &port_label) const
224 {
225 // Search for the port in the inputs vector
226 for (const auto &port : this->ports)
227 if (port->get_label() == port_label)
228 {
229 if (port->get_port_type() == PortType::IN)
230 {
231 auto inputPort = std::dynamic_pointer_cast<Input<T>>(port);
232 if (inputPort) return inputPort->get_value_ref();
233 }
234 else
235 {
236 auto outputPort = std::dynamic_pointer_cast<Output<T>>(port);
237 if (outputPort) return outputPort->get_value_ref();
238 }
239 }
240
241 // If no matching port is found, throw an exception
242 throw std::runtime_error("Port with label '" + port_label + "' not found.");
243 }
244
253 template <typename T> T *get_value_ref(int port_index) const
254 {
255 // Range check for the port index
256 if (port_index < 0 || port_index >= static_cast<int>(this->ports.size()))
257 throw std::out_of_range("Invalid port index");
258
259 // Dynamic cast to the appropriate port type (Input or Output) and return
260 // the value reference if the port is valid, otherwise return nullptr
261 if (this->ports[port_index]->get_port_type() == PortType::IN)
262 {
263 auto port = std::dynamic_pointer_cast<Input<T>>(this->ports[port_index]);
264 return port ? port->get_value_ref() : nullptr;
265 }
266 else
267 {
268 auto port = std::dynamic_pointer_cast<Output<T>>(this->ports[port_index]);
269 return port ? port->get_value_ref() : nullptr;
270 }
271 }
272
280 void *get_value_ref_void(int port_index) const
281 {
282 if (port_index < 0 || port_index >= static_cast<int>(this->ports.size()))
283 throw std::out_of_range("Invalid port index");
284
285 return this->ports[port_index]->get_value_ref_void();
286 }
287
293 bool is_port_connected(int port_index) const;
294
300 bool is_port_connected(const std::string &port_label) const;
301
311 void set_id(std::string new_id) { this->id = new_id; }
312
319 void set_input_data(std::shared_ptr<BaseData> data, int port_index);
320
326 void set_p_graph(Graph *new_p_graph) { this->p_graph = new_p_graph; }
327
335 template <typename T>
336 void set_value(const std::string &port_label, T new_value)
337 {
338 T *p_value = this->get_value_ref<T>(port_label);
340 }
341
346 void update();
347
348private:
352 std::string label;
353
357 std::string id;
358
362 std::vector<std::shared_ptr<Port>> ports;
363
367 Graph *p_graph = nullptr;
368};
369
370} // namespace gnode
The Graph class provides methods for manipulating nodes and connections in a directed graph structure...
Definition graph.hpp:35
Template class for input ports, specialized by data type.
Definition port.hpp:124
Abstract Node class that represents a basic building block in a graph-based system.
Definition node.hpp:34
Node(std::string label)
Construct a new Node object with a specific label.
Definition node.hpp:52
Graph * get_p_graph() const
Get the reference to the belonging graph.
Definition node.hpp:183
std::vector< std::shared_ptr< Port > > ports
A vector of shared pointers to the node's ports.
Definition node.hpp:362
std::string get_graph_id() const
Get the id of the graph.
T * get_value_ref(int port_index) const
Get a reference to the value stored in a port by its index.
Definition node.hpp:253
std::string get_port_label(int port_index) const
Get the label of a port by its index.
Node()=default
Default constructor for Node.
std::string id
The ID of the node.
Definition node.hpp:357
int get_nports() const
Get the total number of ports on the node.
Graph * p_graph
Reference to the graph the node belong to, if any.
Definition node.hpp:367
void set_value(const std::string &port_label, T new_value)
Set the value of a port by its label.
Definition node.hpp:336
std::string get_data_type(int port_index) const
Get the data type of a specific port (input or output).
void update()
Update the node, which involves processing its input and output ports.
std::shared_ptr< BaseData > get_base_data(const std::string &port_label)
Retrieves a shared pointer to the data associated with the port after downcasting.
std::shared_ptr< BaseData > get_output_data(int port_index) const
Get the output data from a specific port index.
int get_port_index(const std::string &port_label) const
Get the index of a port by its label.
T * get_value_ref(const std::string &port_label) const
Get a reference to the value stored in a port by its label.
Definition node.hpp:223
std::shared_ptr< BaseData > get_base_data(int port_index)
Retrieves a shared pointer to the data associated with the port after downcasting.
std::string get_id() const
Get the ID of the node.
Definition node.hpp:153
PortType get_port_type(const std::string &port_label) const
Get the type of a port (input or output) by its label.
void set_p_graph(Graph *new_p_graph)
Set the reference to the belonging graph.
Definition node.hpp:326
std::string get_label() const
Get the label of the node.
Definition node.hpp:146
std::string label
The label of the node.
Definition node.hpp:352
void set_id(std::string new_id)
Set a new identifier for the node.
Definition node.hpp:311
bool is_dirty
Flag indicating whether the node is marked as dirty (requiring an update).
Definition node.hpp:40
virtual void compute()=0
Pure virtual function that forces derived classes to implement the compute method,...
virtual ~Node()=default
Virtual destructor for Node.
void set_input_data(std::shared_ptr< BaseData > data, int port_index)
Set input data on a specific port by its index.
const std::vector< std::shared_ptr< Port > > & get_ports()
Get the ports.
Definition node.hpp:212
Node(std::string label, std::string id)
Construct a new Node object with a specific label and identifier.
Definition node.hpp:65
void * get_value_ref_void(int port_index) const
Get a void* reference to the value stored in a port by its index.
Definition node.hpp:280
bool is_port_connected(int port_index) const
Check if a port is connected by its index.
bool is_port_connected(const std::string &port_label) const
Check if a port is connected by its label.
void add_port(PortType port_type, const std::string &port_label, Args &&...args)
Add a port to the node, specifying whether it is an input or output.
Definition node.hpp:89
int get_nports(PortType port_type) const
Get the number of ports of a specific type (input or output).
Template class for output ports, specialized by data type.
Definition port.hpp:196
Defines the BaseData and Data classes for handling typed data in the gnode namespace.
Definition data.hpp:23
PortType
Enumeration for port types, indicating whether a port is an input or an output.
Definition port.hpp:33
@ IN
Represents an input port.
Definition port.hpp:34
Defines the Port, Input, and Output classes, along with the PortType enumeration for handling ports i...