Ocean
platform/System.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Meta Platforms, Inc. and affiliates.
3  *
4  * This source code is licensed under the MIT license found in the
5  * LICENSE file in the root directory of this source tree.
6  */
7 
8 #ifndef META_OCEAN_PLATFORM_SYSTEM_H
9 #define META_OCEAN_PLATFORM_SYSTEM_H
10 
12 
13 namespace Ocean
14 {
15 
16 namespace Platform
17 {
18 
19 /**
20  * This class implements system functions for any platforms.
21  * @ingroup platform
22  */
23 class OCEAN_PLATFORM_EXPORT System
24 {
25  public:
26 
27  /**
28  * Returns a defined environment variable.
29  * @param variable Environment variable to return
30  * @param removeQuotes Determines whether all beginning and ending quotes are removed from the environment variable, if existent
31  * @return Specified environment variable
32  */
33  static std::string environmentVariable(const std::string& variable, const bool removeQuotes = true);
34 };
35 
36 }
37 
38 }
39 
40 #endif // META_OCEAN_PLATFORM_SYSTEM_H
This class implements system functions for any platforms.
Definition: platform/System.h:24
static std::string environmentVariable(const std::string &variable, const bool removeQuotes=true)
Returns a defined environment variable.
The namespace covering the entire Ocean framework.
Definition: Accessor.h:15