hero123457/uhd
1
0
Fork 0
mirror of https://github.com/EttusResearch/uhd.git synced 2026-10-25 17:36:10 +00:00
Code Issues Projects Releases Wiki Activity

rfnoc: Add more comments to rfnoc_graph

Browse Source 
This adds some more explanatory comments around active and static
connections.
This commit is contained in:
Martin Braun 2021-11-25 14:41:47 +01:00 committed by Aaron Rossetto
parent bc6b453963
commit 7f6e4917a1
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
host/include/uhd/rfnoc_graph.hpp
View File

@ -172,6 +172,9 @@ public:
* Note you need to also call this on statically connected blocks if you
* desire to use them.
*
* Connections that are made using this API call will be listed when calling
* enumerate_active_connections().
*
* \param src_blk The block ID of the source block to connect.
* \param src_port The port of the source block to connect.
* \param dst_blk The block ID of the destination block to connect to.
@ -226,6 +229,9 @@ public:
* connection will not be changed until a new connection is made on the source
* port.
*
* Disconnected edges will no longer be listed in
* enumerate_active_connections().
*
* \param src_blk The block ID of the source block to disconnect.
* \param src_port The port of the source block to disconnect.
* \param dst_blk The block ID of the destination block to disconnect from.
@ -284,12 +290,20 @@ public:
const block_id_t& dst_blk, size_t dst_port) = 0;
/*! Enumerate all the possible static connections in the graph
*
* A static connection is a connection that is statically connected in
* hardware. Note that static connections also need to be declared using
* connect() if an application wants to use them, or they won't be available
* for property propagation or any other graph mechanism.
*
* \return A vector containing all the static edges in the graph.
*/
virtual std::vector<graph_edge_t> enumerate_static_connections() const = 0;
/*! Enumerate all the active connections in the graph
*
* An active connection is a connection which was previously created by
* calling connect().
*
* \return A vector containing all the active edges in the graph.
*/