inference-engine/include/builders/ie_memory_layer.hpp

   1 // Copyright (C) 2018-2019 Intel Corporation
   2 // SPDX-License-Identifier: Apache-2.0
   3 //
   4
   5 #pragma once
   6
   7 #include <builders/ie_layer_decorator.hpp>
   8 #include <ie_network.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 LayerDecorator {
  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 layer pointer to generic builder
  27      */
  28     explicit MemoryLayer(const Layer::Ptr& layer);
  29     /**
  30      * @brief The constructor creates a builder from generic builder
  31      * @param layer constant pointer to generic builder
  32      */
  33     explicit MemoryLayer(const Layer::CPtr& layer);
  34     /**
  35      * @brief Sets the name for the layer
  36      * @param name Layer name
  37      * @return reference to layer builder
  38      */
  39     MemoryLayer& setName(const std::string& name);
  40
  41     /**
  42      * @brief Returns output port
  43      * @return Output port
  44      */
  45     const Port& getOutputPort() const;
  46     /**
  47      * @brief Sets output port
  48      * @param port Output port
  49      * @return reference to layer builder
  50      */
  51     MemoryLayer& setOutputPort(const Port& port);
  52     /**
  53      * @brief Returns input port
  54      * @return Input port
  55      */
  56     const Port& getInputPort() const;
  57     /**
  58      * @brief Sets input port
  59      * @param port Input port
  60      * @return reference to layer builder
  61      */
  62     MemoryLayer& setInputPort(const Port& port);
  63     /**
  64      * @brief Returns memory ID
  65      * @return String with memory ID
  66      */
  67     const std::string getId() const;
  68     /**
  69      * @brief Sets memory ID
  70      * @param id Memory ID
  71      * @return reference to layer builder
  72      */
  73     MemoryLayer& setId(const std::string& id);
  74     /**
  75      * @brief Returns the index of memory layer
  76      * @return Index
  77      */
  78     size_t getIndex() const;
  79     /**
  80      * @brief Sets the index of memory layer
  81      * @param index Index equal 0 means this layer is output one.
  82      * @return reference to layer builder
  83      */
  84     MemoryLayer& setIndex(size_t index);
  85     /**
  86      * @brief Returns size of the group
  87      * @return Size of the group
  88      */
  89     size_t getSize() const;
  90     /**
  91      * @brief Sets size of the group
  92      * @param size Size if size equals 2 means this group is a pair (only 2 is supported).
  93      * @return reference to layer builder
  94      */
  95     MemoryLayer& setSize(size_t size);
  96 };
  97
  98 }  // namespace Builder
  99 }  // namespace InferenceEngine