nnfw::misc::EnvVar Class Reference

Class to access environment variable. More...

#include <EnvVar.h>

Public Member Functions
	EnvVar (const std::string &key)
	Construct a new EnvVar object.
std::string	asString (const std::string &def) const
	Get environment variable of string type.
bool	asBool (bool def) const
	Get environment variable of boolean type.
int	asInt (int def) const
	Get environment variable of int type.
float	asFloat (float def) const
	Get environment variable of float type.

Detailed Description

Class to access environment variable.

Definition at line 38 of file EnvVar.h.

Constructor & Destructor Documentation

EnvVar()

nnfw::misc::EnvVar::EnvVar ( const std::string &  key )

inline

Construct a new EnvVar object.

Parameters

[in]

key

environment variable

Definition at line 45 of file EnvVar.h.

  {
    const char *value = std::getenv(key.c_str());
    if (value == nullptr)
    {
      // An empty string is considered as an empty value
      _value = "";
    }
    else
    {
      _value = value;
    }
  }

Member Function Documentation

asBool()

bool nnfw::misc::EnvVar::asBool ( bool  def ) const

inline

Get environment variable of boolean type.

Parameters

[in]

def

Default value of environment variable

Returns

Defaut value passed as a parameter when there is no environment variable, otherwise the value of environment variable passed into constructor

Definition at line 78 of file EnvVar.h.

  {
    if (_value.empty())
      return def;
    static const std::array<std::string, 5> false_list{"0", "OFF", "FALSE", "N", "NO"};
    auto false_found = std::find(false_list.begin(), false_list.end(), _value);
    return (false_found == false_list.end());
  }

asFloat()

float nnfw::misc::EnvVar::asFloat ( float  def ) const

inline

Get environment variable of float type.

Parameters

[in]

def

Default value of environment variable

Returns

Defaut value passed as a parameter when there is no environment variable, otherwise the value of environment variable passed into constructor

Definition at line 106 of file EnvVar.h.

  {
    if (_value.empty())
      return def;
    return std::stof(_value);
  }

asInt()

int nnfw::misc::EnvVar::asInt ( int  def ) const

inline

Get environment variable of int type.

Parameters

[in]

def

Default value of environment variable

Returns

Defaut value passed as a parameter when there is no environment variable, otherwise the value of environment variable passed into constructor

Definition at line 93 of file EnvVar.h.

  {
    if (_value.empty())
      return def;
    return std::stoi(_value);
  }

asString()

std::string nnfw::misc::EnvVar::asString ( const std::string &  def ) const

inline

Get environment variable of string type.

Parameters

[in]

def

Default value of environment variable

Returns

Defaut value passed as a parameter when there is no environment variable, otherwise the value of environment variable passed into constructor

Definition at line 65 of file EnvVar.h.

  {
    if (_value.empty())
      return def;
    return _value;
  }

---

The documentation for this class was generated from the following file:

• runtime/libs/misc/include/misc/EnvVar.h