GoPxL SDK

- Home
- Files
- Namespace

Version.h
Go to the documentation of this file.
1
10 #ifndef GOPXL_SDK_VERSION_H
11 #define GOPXL_SDK_VERSION_H
12
13 #include "Def.h"
14
15 // This constants defined in this file and the values listed in this confluence page
16 // https://lmitechnologies.atlassian.net/wiki/spaces/GS/pages/1508127/Versions+and+Releases
17 // "Versions and Releases", must be in sync.
18 namespace GoPxLSdk
19 {
20 // The SDK version numbers describes the SDK build version digits.
21 // The backend build scripts will automatically replace these definitions
22 // with the actual version numbers for a build.
23 // For development, we should always set the Major and Minor numbers
24 // to the upcoming release in this file in the code repo.
25 //
26 // The build version is a 32-bit number made up of the digits as follows, where each digit
27 // occupies 8-bits in the version number:
28 // version = MajorMinorReleaseBuild
29 #define GO_PXL_SDK_VERSION_MAJOR 8
30 #define GO_PXL_SDK_VERSION_MINOR 1
31 #define GO_PXL_SDK_VERSION_RELEASE 13
32 #define GO_PXL_SDK_VERSION_BUILD 1
33
34 // The SDK API version is the REST API version used by the SDK to communicate with the device.
35 // Changes to the REST API can affect whether the SDK application can communicate with the device,
36 // so it is important for SDK applications to know if the REST API used by the SDK application's SDK
37 // code matches the REST API of the device.
38 //
39 // Note this version should match the GOREST_API_CURRENT_VERSION.
40 //
41 // GOS-8113 introduced breaking changes to the REST API so major version is incremented from 3 to 4.
42 #define GO_PXL_SDK_API_VERSION_MAJOR 4
43 #define GO_PXL_SDK_API_VERSION_MINOR 0
44 #define GO_PXL_SDK_API_VERSION_PATCH 0
45
59 GoPxLSdkCppFx(kVersion) BuildVersionNumber();
60
74 GoPxLSdkCppFx(const kChar*) BuildVersion();
75
88 GoPxLSdkCppFx(const kChar*) ApiVersion();
89
90 }
91 #endif
GoPxLSdkCppFx
#define GoPxLSdkCppFx(TYPE)
Definition: Def.h:31
GoPxLSdk::BuildVersion
const kChar * BuildVersion()
Returns the SDK build version as a string.
Def.h
Declares the general SDK definitions.
GoPxLSdk::ApiVersion
const kChar * ApiVersion()
Returns the SDK REST API version as string.
GoPxLSdk
Definition: Def.h:46
GoPxLSdk::BuildVersionNumber
kVersion BuildVersionNumber()
Returns the SDK build version as a 32-bit number in the format: MMmmRRBB where: MM = major number mm ...