Class GraphFunction

libchigraph/include/chi/GraphFunction.hpp:23–349

this is an AST-like representation of a function in a graph It is used for IDE-like behavior, codegen, and JSON generation.

/// this is an AST-like representation of a function in a graph
/// It is used for IDE-like behavior, codegen, and JSON generation.
struct GraphFunction {
	/// Construct a graph--don't call this directly use GraphModule::getorCreateFunction
	/// \param mod The owning module
	/// \param name The name of the function
	/// \param dataIns The data inputs to the function
	/// \param dataOuts The data outputs of the function
	/// \param execIns The exec inputs to the function
	/// \param execOuts The exec outputs to the function
	GraphFunction(GraphModule& mod, std::string name, std::vector<NamedDataType> dataIns,
	              std::vector<NamedDataType> dataOuts, std::vector<std::string> execIns,
	              std::vector<std::string> execOuts);

	GraphFunction(const GraphFunction&) = delete;
	GraphFunction(GraphFunction&&)      = delete;

	GraphFunction& operator=(const GraphFunction&) = delete;
	GraphFunction& operator=(GraphFunction&&) = delete;

	/// Destructor
	~GraphFunction() = default;

	/// \name Node Manipulation
	/// Functions for mainpulating nodes; getting, adding
	/// \{

	/// Get the nodes in the function
	/// Usually called by connectData or connectExec or GraphFunction
	/// \return The nodes, mapped by id, value
	std::unordered_map<boost::uuids::uuid, std::unique_ptr<NodeInstance>>& nodes() {
		return mNodes;
	}
	/// \copydoc GraphFunction::nodes
	const std::unordered_map<boost::uuids::uuid, std::unique_ptr<NodeInstance>>& nodes() const {
		return mNodes;
	}

	/// Get a node with a given ID
	/// \param id The ID of the node
	/// \return The NodeInstance, or nullptr if the ID wasn't found
	NodeInstance* nodeByID(const boost::uuids::uuid& id) const;

	/// Gets the node with type lang:entry
	/// returns nullptr on failure
	/// Also returns nullptr if there are two entry nodes, which is illegal
	/// \return the entry node
	NodeInstance* entryNode() const noexcept;

	/// Add a node to the graph
	/// \param[in] type The type of the node
	/// \param[in] x The x location of the node
	/// \param[in] y The y location of the node
	/// \param[in] id The node ID
	/// \param[out] toFill The nodeInstance to fill to, optional.
	/// \return The result
	Result insertNode(std::unique_ptr<NodeType> type, float x, float y,
	                  boost::uuids::uuid id     = boost::uuids::random_generator()(),
	                  NodeInstance**     toFill = nullptr);