ie_memory_layer.hpp
1 // Copyright (C) 2018 Intel Corporation
2 // SPDX-License-Identifier: Apache-2.0
3 //
4 
5 #pragma once
6 
7 #include <builders/ie_layer_fragment.hpp>
8 #include <ie_inetwork.hpp>
9 #include <string>
10 
11 namespace InferenceEngine {
12 namespace Builder {
13 
14 /**
15  * @brief The class represents a builder for Memory layer
16  */
17 class INFERENCE_ENGINE_API_CLASS(MemoryLayer): public LayerFragment {
18 public:
19  /**
20  * @brief The constructor creates a builder with the name
21  * @param name Layer name
22  */
23  explicit MemoryLayer(const std::string& name = "");
24  /**
25  * @brief The constructor creates a builder from generic builder
26  * @param genLayer generic builder
27  */
28  explicit MemoryLayer(Layer& genLayer);
29  /**
30  * @brief Sets the name for the layer
31  * @param name Layer name
32  * @return reference to layer builder
33  */
34  MemoryLayer& setName(const std::string& name);
35 
36  /**
37  * @brief Returns output port
38  * @return Output port
39  */
40  const Port& getOutputPort() const;
41  /**
42  * @brief Sets output port
43  * @param port Output port
44  * @return reference to layer builder
45  */
46  MemoryLayer& setOutputPort(const Port& port);
47  /**
48  * @brief Returns input port
49  * @return Input port
50  */
51  const Port& getInputPort() const;
52  /**
53  * @brief Sets input port
54  * @param port Input port
55  * @return reference to layer builder
56  */
57  MemoryLayer& setInputPort(const Port& port);
58  /**
59  * @brief Returns memory ID
60  * @return String with memory ID
61  */
62  const std::string getId() const;
63  /**
64  * @brief Sets memory ID
65  * @param id Memory ID
66  * @return reference to layer builder
67  */
68  MemoryLayer& setId(const std::string& id);
69  /**
70  * @brief Returns the index of memory layer
71  * @return Index
72  */
73  size_t getIndex() const;
74  /**
75  * @brief Sets the index of memory layer
76  * @param index Index equal 0 means this layer is output one.
77  * @return reference to layer builder
78  */
79  MemoryLayer& setIndex(size_t index);
80  /**
81  * @brief Returns size of the group
82  * @return Size of the group
83  */
84  size_t getSize() const;
85  /**
86  * @brief Sets size of the group
87  * @param size Size if size equals 2 means this group is a pair (only 2 is supported).
88  * @return reference to layer builder
89  */
90  MemoryLayer& setSize(size_t size);
91 };
92 
93 } // namespace Builder
94 } // namespace InferenceEngine
InferenceEngine
Definition: ie_argmax_layer.hpp:11
ie_inetwork.hpp
a header file for the Inference Engine Network interface