iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Helpers to access values of shell/Unix environment variables used by NRT

Enumerations

enum  nrt::Environment {
  nrt::Environment::NRTHOME, nrt::Environment::NRTMASTER, nrt::Environment::NRTMODULEPATH, nrt::Environment::NRTMESSAGEPATH,
  nrt::Environment::NRTMACROMODULEPATH, nrt::Environment::NRTNETWORKPATH, nrt::Environment::NRTAUTHOR
}
 Enum that defines all the environment variables used by NRT. More...
 

Functions

std::string nrt::getenv (Environment const e)
 Get the value of an environment variable. More...
 
std::string nrt::getenvdescription (Environment const e)
 Get the description of an environment variable. More...
 
std::string nrt::getenvname (Environment const e)
 Get the nameof an environment variable as used by the Unix Shell. More...
 

Enumeration Type Documentation

enum nrt::Environment
strong

Enum that defines all the environment variables used by NRT.

The enum entries used here directly match the environment variable names. The enum is used to provide strongly-typed, typo-proof access to these variables.

Enumerator
NRTHOME 

Root NRT directory. Many other variables have defaults relative to NRTHOME if not set.

NRTMASTER 

IP address (or hostname) and port of the Blackboard master.

NRTMODULEPATH 

Colon-separated path list to NRT modules.

NRTMESSAGEPATH 

Colon-separated path list to NRT messages.

NRTMACROMODULEPATH 

Colon-separated path list to NRT macro-modules.

NRTNETWORKPATH 

Colon-separated path list to NRT networks.

NRTAUTHOR 

Semicolon-separated info about an author, used to create manifests.

Definition at line 49 of file Environment.H.

Function Documentation

std::string nrt::getenv ( Environment const  e)

Get the value of an environment variable.

If the variable is set, then use that value. Otherwise, use some default (see implementation).

std::string nrt::getenvdescription ( Environment const  e)

Get the description of an environment variable.

std::string nrt::getenvname ( Environment const  e)

Get the nameof an environment variable as used by the Unix Shell.