summaryrefslogtreecommitdiff
path: root/runtimes/neurun/core/src/dumper/dot/Node.h
blob: 364cb08a4d43ef929c39b7e58d9f01d5ea64a572 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/*
 * Copyright (c) 2019 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * 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.
 */

/**
 * @file Node.h
 * @brief    This file contains Node class
 * @ingroup  COM_AI_RUNTIME
 *
 */

#ifndef __NEURUN_DUMPER_DOT_NODE_H__
#define __NEURUN_DUMPER_DOT_NODE_H__

#include <string>
#include <memory>
#include <vector>
#include <unordered_map>

namespace neurun
{
namespace dumper
{
namespace dot
{

enum BGCOLORS : int
{
  RED,
  BLUE,
  GREEN,
  PUPLE,
  ORANGE,
  YELLOW,
  BROWN,
  PINK
};

/**
 * @brief Class that represents a Node in "dot" format
 *
*/
class Node
{
public:
  const static std::string DEFAULT_FILLCOLOR;
  const static std::string DEFAULT_COLORSCHEME;
  const static std::string BG_COLORS[8];

public:
  /**
   * @brief Destroy the Node object
   *
  */
  virtual ~Node() = default;

  /**
   * @brief Construct a new Node object
   *
   * @param id
  */
  Node(const std::string &id);

  /**
   * @brief return id
   *
   * @return id
  */
  std::string id() const { return _id; }

  /**
   * @brief return attributes
   *
   * @return const reference of attributes object
  */
  const std::unordered_map<std::string, std::string> &attributes() const { return _attributes; }
  /**
   * @brief Store an attribute with key-value pair
   *
   * @param[in] key attribute's key
   * @param[in] val attribute's value that is associated with the key
  */
  void setAttribute(const std::string &key, const std::string &val);
  /**
   * @brief Get the attributte value that is associated with key
   *
   * @param[in] key key of the attribute
   * @return value that is associated with the key
  */
  std::string getAttribute(const std::string &key);

  /**
   * @brief Add an edge in the graph, which is an outgoing edge
   *
   * @param[in] dotinfo A node that the new edge will be connected to
  */
  void addEdge(std::shared_ptr<Node> dotinfo) { _children.emplace_back(dotinfo); }
  /**
   * @brief Return list of edges
   *
   * @return Edges
  */
  const std::vector<std::shared_ptr<Node>> &edges() const { return _children; }

private:
  std::string _id;
  std::unordered_map<std::string, std::string> _attributes;
  std::vector<std::shared_ptr<Node>> _children;
};

} // namespace dot
} // namespace dumper
} // namespace neurun

#endif // __NEURUN_DUMPER_DOT_NODE_H__