OSEnvironment.hxx

Go to the documentation of this file.

//Copyright 2022 Siemens Digital Industries Software
//==================================================
//Copyright $2010.
//Siemens Product Lifecycle Management Software Inc.
//All Rights Reserved.
//==================================================
//Copyright 2022 Siemens Digital Industries Software

#ifndef BASE_UTILS_OSENVIRONMENT_HXX
#define BASE_UTILS_OSENVIRONMENT_HXX

#include <string>
#include <map>
#include <base_utils/libbase_utils_exports.h>

namespace Teamcenter
{
namespace OSEnvironment
{
    BASE_UTILS_API std::string get(
        const std::string & name,                        
        bool applyOSEnvNameMapping = true,               
        bool throwStdExceptionIfNotFound = false         
        );                                              //lint !e1761 This is a non-member function and can be used without ambiguity after resolving the namespace at caller location. 2015-06-19

    BASE_UTILS_API bool has(
        const std::string & name,                  
        bool applyOSEnvNameMapping = true          
        );

    BASE_UTILS_API void set(
        const std::string & name,                   
        const std::string & value,                  
        bool applyOSEnvNameMapping = true           
        );                                          //lint !e1761 This is a non-member function and can be used without ambiguity after resolving the namespace at caller location. 2015-06-19


    BASE_UTILS_API void addPrefixMapping(
        const std::string & oldPrefix, 
        const std::string & newPrefix  
        );


    BASE_UTILS_API void removePrefixMapping(
        const std::string &oldPrefix 
        );

    BASE_UTILS_API std::string getMappedName(
        const std::string & originalName 
        );


    BASE_UTILS_API const std::map< std::string, std::string > & getNamePrefixMap();     //lint !e1929 This function returns a const reference. Further the const reference of a member variable of a singleton whose lifecycle is managed well. 2015-06-19
}
}
#include <base_utils/libbase_utils_undef.h>
#endif