edge.h

// Copyright 2018-2019 Delft University of Technology
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#pragma once
 
#include <algorithm>
#include <iostream>
#include <utility>
#include <memory>
#include <string>
#include <vector>
 
#include "cerata/utils.h"
#include "cerata/node.h"
#include "cerata/array.h"
#include "cerata/pool.h"
 
namespace cerata {
 
// Forward decl.
class Component;
 
class Edge : public Named {
 public:
  static std::shared_ptr<Edge> Make(const std::string &name, Node *dst, Node *src);
 
  [[nodiscard]] std::optional<Node *> GetOtherNode(const Node &node) const;
 
  [[nodiscard]] Node *dst() const { return dst_; }
  [[nodiscard]] Node *src() const { return src_; }
 
 protected:
  Edge(std::string name, Node *dst, Node *src);
 
  Node *dst_;
  Node *src_;
};
 
std::shared_ptr<Edge> Connect(Node *dst, Node *src);
 
std::shared_ptr<Edge> Connect(Node *dst, const std::shared_ptr<Node> &src);
 
std::shared_ptr<Edge> Connect(const std::shared_ptr<Node> &dst, Node *src);
 
std::shared_ptr<Edge> Connect(const std::shared_ptr<Node> &dst, const std::shared_ptr<Node> &src);
 
std::shared_ptr<Edge> Connect(Node *dst, std::string str);
 
// Connect operators:
 
std::shared_ptr<Edge> operator<<=(Node *dst, const std::shared_ptr<Node> &src);
std::shared_ptr<Edge> operator<<=(const std::shared_ptr<Node> &dst, const std::shared_ptr<Node> &src);
std::shared_ptr<Edge> operator<<=(const std::shared_ptr<Node> &dst, Node *src);
 
std::vector<Edge *> GetAllEdges(const Graph &graph);
 
Signal *AttachSignalToNode(Component *comp, NormalNode *node, NodeMap *rebinding, std::string name = "");
 
SignalArray *AttachSignalArrayToNodeArray(Component *comp, NodeArray *array, NodeMap *rebinding);
 
}  // namespace cerata