Publishing 2019 R3 content

[platform/upstream/dldt.git] / inference-engine / include / cpp / ie_executable_network.hpp

diff --git a/inference-engine/include/cpp/ie_executable_network.hpp b/inference-engine/include/cpp/ie_executable_network.hpp
index 2eb235a..6a3e716 100644 (file)
--- a/inference-engine/include/cpp/ie_executable_network.hpp
+++ b/inference-engine/include/cpp/ie_executable_network.hpp
@@ -30,17 +30,31 @@ class ExecutableNetwork {
     InferenceEnginePluginPtr plg;
 
 public:
+    /**
+     * @brief Default constructor
+     */
     ExecutableNetwork() = default;
+
+    /**
+     * @brief Destructor
+     */
     ~ExecutableNetwork() {
         actual = nullptr;
     }
 
+    /**
+     * @brief Constructs ExecutableNetwork from the initialized shared_pointer
+     * @param actual Initialized shared pointer
+     * @param plg Plugin to use
+     */
     explicit ExecutableNetwork(IExecutableNetwork::Ptr actual, InferenceEnginePluginPtr plg = {})
     : actual(actual), plg(plg) {}
 
     /**
-     * @brief Wraps original method
-     * IExecutableNetwork::getOutputsInfo
+     * @copybrief IExecutableNetwork::GetOutputsInfo
+     * 
+     * Wraps IExecutableNetwork::GetOutputsInfo.
+     * @return A collection that contains string as key, and const Data smart pointer as value
      */
     ConstOutputsDataMap GetOutputsInfo() const {
         ConstOutputsDataMap data;
@@ -49,8 +63,10 @@ public:
     }
 
     /**
-     * @brief Wraps original method
-     * IExecutableNetwork::getInputsInfo
+     * @copybrief IExecutableNetwork::GetInputsInfo
+     * 
+     * Wraps IExecutableNetwork::GetInputsInfo
+     * @return A collection that contains string as key, and const InputInfo smart pointer as value
      */
     ConstInputsDataMap GetInputsInfo() const {
         ConstInputsDataMap info;
@@ -59,16 +75,20 @@ public:
     }
 
     /**
-     * @brief reset owned object to new pointer, essential for cases when simultaneously loaded networks not expected
-     * @param actual actual pointed object
+     * @brief reset owned object to new pointer.
+     * 
+     * Eessential for cases when simultaneously loaded networks not expected.
+     * @param newActual actual pointed object
      */
     void reset(IExecutableNetwork::Ptr newActual) {
         this->actual.swap(newActual);
     }
 
     /**
-     * @brief Wraps original method
-     * IExecutableNetwork::CreateInferRequest
+     * @copybrief IExecutableNetwork::CreateInferRequest
+     * 
+     * Wraps IExecutableNetwork::CreateInferRequest.
+     * @return InferRequest object
      */
     InferRequest CreateInferRequest() {
         IInferRequest::Ptr req;
@@ -78,9 +98,10 @@ public:
     }
 
     /**
-     * @brief Wraps original method
-     * IExecutableNetwork::CreateInferRequestPtr
-     * @return shared pointer on InferRequest object
+     * @copybrief IExecutableNetwork::CreateInferRequest
+     * 
+     * Wraps IExecutableNetwork::CreateInferRequest.
+     * @return shared pointer on InferenceEngine::InferRequest object
      */
     InferRequest::Ptr CreateInferRequestPtr() {
         IInferRequest::Ptr req;
@@ -89,18 +110,24 @@ public:
     }
 
     /**
-    * @brief Exports the current executable network so it can be used later in the Import() main API
+    * @copybrief IExecutableNetwork::Export
+    * 
+    * Wraps IExecutableNetwork::Export.
+    * 
+    * @see Core::ImportNetwork
+    * @see InferencePlugin::ImportNetwork
+    * 
     * @param modelFileName Full path to the location of the exported file
-    * @param resp Optional: pointer to an already allocated object to contain information in case of failure
     */
     void Export(const std::string &modelFileName) {
         CALL_STATUS_FNC(Export, modelFileName);
     }
 
     /**
-    * @brief Gets the mapping of IR layer names to implemented kernels
+    * @copybrief IExecutableNetwork::GetMappedTopology
+    * 
+    * Wraps IExecutableNetwork::GetMappedTopology.
     * @param deployedTopology Map of PrimitiveInfo objects that represent the deployed topology
-    * @param resp Optional: pointer to an already allocated object to contain information in case of failure
     */
     void GetMappedTopology(std::map<std::string, std::vector<PrimitiveInfo::Ptr>> &deployedTopology) {
         CALL_STATUS_FNC(GetMappedTopology, deployedTopology);
@@ -115,7 +142,9 @@ public:
     }
 
     /**
-    * @brief Get executable graph information from a plugin represented as CNNNetwork
+    * @copybrief IExecutableNetwork::GetExecGraphInfo
+    * 
+    * Wraps IExecutableNetwork::GetExecGraphInfo.
     * @return CNNetwork containing Executable Graph Info
     */
     CNNNetwork GetExecGraphInfo() {
@@ -125,7 +154,10 @@ public:
     }
 
     /**
-     *@brief see original function InferenceEngine::IExecutableNetwork::QueryState
+     * @copybrief IExecutableNetwork::QueryState
+     * 
+     * Wraps IExecutableNetwork::QueryState
+     * @return A vector of Memory State objects
      */
     std::vector<MemoryState> QueryState() {
         IMemoryState::Ptr pState = nullptr;
@@ -146,20 +178,21 @@ public:
     }
 
     /**
-     * @brief Sets configuration for current executable network
+     * @copybrief IExecutableNetwork::SetConfig
+     * 
+     * Wraps IExecutableNetwork::SetConfig.
      * @param config Map of pairs: (config parameter name, config parameter value)
-     * @param resp Pointer to the response message that holds a description of an error if any occurred
      */
     void SetConfig(const std::map<std::string, Parameter> &config) {
         CALL_STATUS_FNC(SetConfig, config);
     }
 
-    /** @brief Gets configuration dedicated to plugin behaviour
-        * @param name - config key, can be found in ie_plugin_config.hpp
-        * @param options - configuration details for coonfig value
-        * @param result - value of config corresponding to config key
-        * @param resp Pointer to the response message that holds a description of an error if any occurred
-    */
+    /** @copybrief IExecutableNetwork::GetConfig
+     * 
+     * Wraps IExecutableNetwork::GetConfig
+     * @param name - config key, can be found in ie_plugin_config.hpp
+     * @return Configuration paramater value
+     */
     Parameter GetConfig(const std::string &name) const {
         Parameter configValue;
         CALL_STATUS_FNC(GetConfig, name, configValue);
@@ -167,13 +200,11 @@ public:
     }
 
     /**
-     * @brief Gets general runtime metric for dedicated hardware
+     * @copybrief IExecutableNetwork::GetMetric
+     * 
+     * Wraps IExecutableNetwork::GetMetric
      * @param name  - metric name to request
-     * @param options - configuration details for metric
-     * @param result - metric value corresponding to metric key
-     * @param resp - Pointer to the response message that holds a description of an error if any
-     *             occurred
-     * @return code of the operation. OK if succeeded
+     * @return Metric paramater value
      */
     Parameter GetMetric(const std::string &name) const {
         Parameter metricValue;
@@ -181,6 +212,9 @@ public:
         return metricValue;
     }
 
+    /**
+     * @brief A smart pointer to the ExecutableNetwork object
+     */
     using Ptr = std::shared_ptr<ExecutableNetwork>;
 };