Publishing 2020.1 content
[platform/upstream/dldt.git] / inference-engine / include / ie_version.hpp
1 // Copyright (C) 2018-2020 Intel Corporation
2 // SPDX-License-Identifier: Apache-2.0
3 //
4
5 /**
6  * @brief A header file that provides versioning information for the inference engine shared library
7  *
8  * @file ie_version.hpp
9  */
10 #pragma once
11
12 #include "ie_api.h"
13
14 namespace InferenceEngine {
15
16 /**
17  * @struct Version
18  * @brief  Represents version information that describes plugins and the inference engine runtime library
19  */
20 #pragma pack(push, 1)
21 struct Version {
22     /**
23      * @brief An API version reflects the set of supported features
24      */
25     struct {
26         int major;
27         int minor;
28     } apiVersion;
29     /**
30      * @brief A null terminated string with build number
31      */
32     const char* buildNumber;
33     /**
34      * @brief A null terminated description string
35      */
36     const char* description;
37 };
38 #pragma pack(pop)
39
40 /**
41  * @brief Gets the current Inference Engine version
42  *
43  * @return The current Inference Engine version
44  */
45 INFERENCE_ENGINE_API(const Version*) GetInferenceEngineVersion() noexcept;
46
47 }  // namespace InferenceEngine