Generated implementations of GetRuntimeVersion.

inc/osvr/Client/GetRuntimeVersion.h

@@ -1,5 +1,9 @@
 /** @file
-    @brief Header
+    @brief Header for accessing runtime version information.
+
+    Generated by running:
+
+    `cmake -P src/osvr/GenerateGetRuntimeVersion.cmake`
 
     @date 2015
 

inc/osvr/Common/GetRuntimeVersion.h

@@ -0,0 +1,77 @@
+/** @file
+    @brief Header for accessing runtime version information.
+
+    Generated by running:
+
+    `cmake -P src/osvr/GenerateGetRuntimeVersion.cmake`
+
+    @date 2015
+
+    @author
+    Sensics, Inc.
+    <http://sensics.com/osvr>
+*/
+
+// Copyright 2015 Sensics, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef INCLUDED_GetRuntimeVersion_h_GUID_5BF26574_26A9_4DB1_27B9_B5B8E69F2AE1
+#define INCLUDED_GetRuntimeVersion_h_GUID_5BF26574_26A9_4DB1_27B9_B5B8E69F2AE1
+
+// Internal Includes
+#include <osvr/Common/Export.h>
+#include <osvr/Util/RuntimeNumericVersion.h>
+
+// Library/third-party includes
+// - none
+
+// Standard includes
+// - none
+
+namespace osvr {
+namespace common {
+    /// @brief Returns the value of the version component (zero-indexed)
+    /// specified, in the inclusive range [0,3].
+    /// @return version component value, or 0 if component out of range.
+    OSVR_COMMON_EXPORT util::NumericVersionComponent
+    getVersionComponent(uint8_t componentIndex);
+
+    /// @brief Gets all numeric components of the runtime version in a tuple.
+    OSVR_COMMON_EXPORT util::RuntimeNumericVersion getRuntimeNumericVersion();
+
+    /// @brief Gets the Git commit hash corresponding to this library build.
+    /// @returns an empty string if the commit hash could not be detected.
+    OSVR_COMMON_EXPORT const char *getCommit();
+
+    /// @brief Gets the full descriptive version string, typically including the
+    /// numerical version components and the commit hash.
+    OSVR_COMMON_EXPORT const char *getVersionString();
+
+    /// @brief If this was built by the CI, return the "Build Tag" the CI
+    /// associated with the build job. (Unrelated to git tags.)
+    /// @returns empty string if we don't have a CI build tag recorded.
+    OSVR_COMMON_EXPORT const char *getCIBuildTag();
+
+    /// @brief Does this build identify itself as a dev build, rather than a
+    /// CI-build "production" build? This is not necessarily 100% accurate - for
+    /// informational purposes only.
+    OSVR_COMMON_EXPORT bool isKnownDevBuild();
+
+    /// @brief Gets the name of this library/module, or an empty string if the
+    /// build system did not incorporate this information into the build.
+    OSVR_COMMON_EXPORT const char *getModuleName();
+} // namespace common
+} // namespace osvr
+
+#endif // INCLUDED_GetRuntimeVersion_h_GUID_5BF26574_26A9_4DB1_27B9_B5B8E69F2AE1

inc/osvr/Connection/GetRuntimeVersion.h

@@ -0,0 +1,77 @@
+/** @file
+    @brief Header for accessing runtime version information.
+
+    Generated by running:
+
+    `cmake -P src/osvr/GenerateGetRuntimeVersion.cmake`
+
+    @date 2015
+
+    @author
+    Sensics, Inc.
+    <http://sensics.com/osvr>
+*/
+
+// Copyright 2015 Sensics, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef INCLUDED_GetRuntimeVersion_h_GUID_6FCB818C_A087_4CB8_E0C4_29B472CCE703
+#define INCLUDED_GetRuntimeVersion_h_GUID_6FCB818C_A087_4CB8_E0C4_29B472CCE703
+
+// Internal Includes
+#include <osvr/Connection/Export.h>
+#include <osvr/Util/RuntimeNumericVersion.h>
+
+// Library/third-party includes
+// - none
+
+// Standard includes
+// - none
+
+namespace osvr {
+namespace connection {
+    /// @brief Returns the value of the version component (zero-indexed)
+    /// specified, in the inclusive range [0,3].
+    /// @return version component value, or 0 if component out of range.
+    OSVR_CONNECTION_EXPORT util::NumericVersionComponent
+    getVersionComponent(uint8_t componentIndex);
+
+    /// @brief Gets all numeric components of the runtime version in a tuple.
+    OSVR_CONNECTION_EXPORT util::RuntimeNumericVersion getRuntimeNumericVersion();
+
+    /// @brief Gets the Git commit hash corresponding to this library build.
+    /// @returns an empty string if the commit hash could not be detected.
+    OSVR_CONNECTION_EXPORT const char *getCommit();
+
+    /// @brief Gets the full descriptive version string, typically including the
+    /// numerical version components and the commit hash.
+    OSVR_CONNECTION_EXPORT const char *getVersionString();
+
+    /// @brief If this was built by the CI, return the "Build Tag" the CI
+    /// associated with the build job. (Unrelated to git tags.)
+    /// @returns empty string if we don't have a CI build tag recorded.
+    OSVR_CONNECTION_EXPORT const char *getCIBuildTag();
+
+    /// @brief Does this build identify itself as a dev build, rather than a
+    /// CI-build "production" build? This is not necessarily 100% accurate - for
+    /// informational purposes only.
+    OSVR_CONNECTION_EXPORT bool isKnownDevBuild();
+
+    /// @brief Gets the name of this library/module, or an empty string if the
+    /// build system did not incorporate this information into the build.
+    OSVR_CONNECTION_EXPORT const char *getModuleName();
+} // namespace connection
+} // namespace osvr
+
+#endif // INCLUDED_GetRuntimeVersion_h_GUID_6FCB818C_A087_4CB8_E0C4_29B472CCE703

inc/osvr/PluginHost/GetRuntimeVersion.h

@@ -0,0 +1,77 @@
+/** @file
+    @brief Header for accessing runtime version information.
+
+    Generated by running:
+
+    `cmake -P src/osvr/GenerateGetRuntimeVersion.cmake`
+
+    @date 2015
+
+    @author
+    Sensics, Inc.
+    <http://sensics.com/osvr>
+*/
+
+// Copyright 2015 Sensics, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef INCLUDED_GetRuntimeVersion_h_GUID_4A6A0FF9_4A87_4F9E_1192_82AEA1E1DF58
+#define INCLUDED_GetRuntimeVersion_h_GUID_4A6A0FF9_4A87_4F9E_1192_82AEA1E1DF58
+
+// Internal Includes
+#include <osvr/PluginHost/Export.h>
+#include <osvr/Util/RuntimeNumericVersion.h>
+
+// Library/third-party includes
+// - none
+
+// Standard includes
+// - none
+
+namespace osvr {
+namespace pluginhost {
+    /// @brief Returns the value of the version component (zero-indexed)
+    /// specified, in the inclusive range [0,3].
+    /// @return version component value, or 0 if component out of range.
+    OSVR_PLUGINHOST_EXPORT util::NumericVersionComponent
+    getVersionComponent(uint8_t componentIndex);
+
+    /// @brief Gets all numeric components of the runtime version in a tuple.
+    OSVR_PLUGINHOST_EXPORT util::RuntimeNumericVersion getRuntimeNumericVersion();
+
+    /// @brief Gets the Git commit hash corresponding to this library build.
+    /// @returns an empty string if the commit hash could not be detected.
+    OSVR_PLUGINHOST_EXPORT const char *getCommit();
+
+    /// @brief Gets the full descriptive version string, typically including the
+    /// numerical version components and the commit hash.
+    OSVR_PLUGINHOST_EXPORT const char *getVersionString();
+
+    /// @brief If this was built by the CI, return the "Build Tag" the CI
+    /// associated with the build job. (Unrelated to git tags.)
+    /// @returns empty string if we don't have a CI build tag recorded.
+    OSVR_PLUGINHOST_EXPORT const char *getCIBuildTag();
+
+    /// @brief Does this build identify itself as a dev build, rather than a
+    /// CI-build "production" build? This is not necessarily 100% accurate - for
+    /// informational purposes only.
+    OSVR_PLUGINHOST_EXPORT bool isKnownDevBuild();
+
+    /// @brief Gets the name of this library/module, or an empty string if the
+    /// build system did not incorporate this information into the build.
+    OSVR_PLUGINHOST_EXPORT const char *getModuleName();
+} // namespace pluginhost
+} // namespace osvr
+
+#endif // INCLUDED_GetRuntimeVersion_h_GUID_4A6A0FF9_4A87_4F9E_1192_82AEA1E1DF58

inc/osvr/Server/GetRuntimeVersion.h

@@ -0,0 +1,77 @@
+/** @file
+    @brief Header for accessing runtime version information.
+
+    Generated by running:
+
+    `cmake -P src/osvr/GenerateGetRuntimeVersion.cmake`
+
+    @date 2015
+
+    @author
+    Sensics, Inc.
+    <http://sensics.com/osvr>
+*/
+
+// Copyright 2015 Sensics, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef INCLUDED_GetRuntimeVersion_h_GUID_8513C123_CF38_4F9F_586F_1A1FDA5463BA
+#define INCLUDED_GetRuntimeVersion_h_GUID_8513C123_CF38_4F9F_586F_1A1FDA5463BA
+
+// Internal Includes
+#include <osvr/Server/Export.h>
+#include <osvr/Util/RuntimeNumericVersion.h>
+
+// Library/third-party includes
+// - none
+
+// Standard includes
+// - none
+
+namespace osvr {
+namespace server {
+    /// @brief Returns the value of the version component (zero-indexed)
+    /// specified, in the inclusive range [0,3].
+    /// @return version component value, or 0 if component out of range.
+    OSVR_SERVER_EXPORT util::NumericVersionComponent
+    getVersionComponent(uint8_t componentIndex);
+
+    /// @brief Gets all numeric components of the runtime version in a tuple.
+    OSVR_SERVER_EXPORT util::RuntimeNumericVersion getRuntimeNumericVersion();
+
+    /// @brief Gets the Git commit hash corresponding to this library build.
+    /// @returns an empty string if the commit hash could not be detected.
+    OSVR_SERVER_EXPORT const char *getCommit();
+
+    /// @brief Gets the full descriptive version string, typically including the
+    /// numerical version components and the commit hash.
+    OSVR_SERVER_EXPORT const char *getVersionString();
+
+    /// @brief If this was built by the CI, return the "Build Tag" the CI
+    /// associated with the build job. (Unrelated to git tags.)
+    /// @returns empty string if we don't have a CI build tag recorded.
+    OSVR_SERVER_EXPORT const char *getCIBuildTag();
+
+    /// @brief Does this build identify itself as a dev build, rather than a
+    /// CI-build "production" build? This is not necessarily 100% accurate - for
+    /// informational purposes only.
+    OSVR_SERVER_EXPORT bool isKnownDevBuild();
+
+    /// @brief Gets the name of this library/module, or an empty string if the
+    /// build system did not incorporate this information into the build.
+    OSVR_SERVER_EXPORT const char *getModuleName();
+} // namespace server
+} // namespace osvr
+
+#endif // INCLUDED_GetRuntimeVersion_h_GUID_8513C123_CF38_4F9F_586F_1A1FDA5463BA