ARC SDK
Static Public Member Functions
Arc::ArcLocation Class Reference

Determines ARC installation location. More...

#include <arc/ArcLocation.h>

Static Public Member Functions

static void Init (std::string path)
 Initializes location information. More...
 
static const std::string & Get ()
 Returns ARC installation location. More...
 
static std::list< std::string > GetPlugins ()
 Returns ARC plugins directory location. More...
 
static std::string GetDataDir ()
 Returns location of ARC system data, e.g. $ARC_LOCATION/share/arc. More...
 
static std::string GetLibDir ()
 Returns location of ARC system libraries, e.g. $ARC_LOCATION/lib/arc. More...
 
static std::string GetToolsDir ()
 Returns location of ARC system tools, e.g. $ARC_LOCATION/libexec/arc. More...
 

Detailed Description

Determines ARC installation location.

Member Function Documentation

◆ Get()

static const std::string& Arc::ArcLocation::Get ( )
static

Returns ARC installation location.

◆ GetDataDir()

static std::string Arc::ArcLocation::GetDataDir ( )
static

Returns location of ARC system data, e.g. $ARC_LOCATION/share/arc.

Since
Added in 3.0.0

◆ GetLibDir()

static std::string Arc::ArcLocation::GetLibDir ( )
static

Returns location of ARC system libraries, e.g. $ARC_LOCATION/lib/arc.

Since
Added in 4.2.0

◆ GetPlugins()

static std::list<std::string> Arc::ArcLocation::GetPlugins ( )
static

Returns ARC plugins directory location.

Main source is value of variable ARC_PLUGIN_PATH, otherwise path is derived from installation location.

◆ GetToolsDir()

static std::string Arc::ArcLocation::GetToolsDir ( )
static

Returns location of ARC system tools, e.g. $ARC_LOCATION/libexec/arc.

Since
Added in 3.0.0

◆ Init()

static void Arc::ArcLocation::Init ( std::string  path)
static

Initializes location information.

Main source is value of variable ARC_LOCATION, otherwise path to executable provided in path is used. If nothing works then warning message is sent to logger and initial installation prefix is used.


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