Lean  $LEAN_TAG$
QuantConnect.Globals Class Reference

Provides application level constant values More...

Static Public Member Functions

static void Reset ()
 Resets global values with the Config data. More...
 
static string GetDataFolderPath (string relativePath)
 Helper method that will build a data folder path checking if it exists on the cache folder else will return data folder More...
 

Static Public Attributes

const string Cache = "./cache/data"
 The directory used for storing downloaded remote files More...
 

Properties

static string Api [get, set]
 The base api url address to use More...
 
static int UserId [get, set]
 The user Id More...
 
static int ProjectId [get, set]
 The project id More...
 
static string UserToken [get, set]
 The user token More...
 
static string OrganizationID [get, set]
 The organization id More...
 
static string ResultsDestinationFolder [get, set]
 The results destination folder More...
 
static string DataFolder [get]
 The root directory of the data folder for this application More...
 
static bool LiveMode [get]
 True if running in live mode More...
 
static string Version [get]
 The version of lean More...
 
static string CacheDataFolder [get]
 Data path to cache folder location More...
 

Detailed Description

Provides application level constant values

Definition at line 26 of file Globals.cs.

Member Function Documentation

◆ Reset()

static void QuantConnect.Globals.Reset ( )
static

Resets global values with the Config data.

Definition at line 76 of file Globals.cs.

Here is the call graph for this function:

◆ GetDataFolderPath()

static string QuantConnect.Globals.GetDataFolderPath ( string  relativePath)
static

Helper method that will build a data folder path checking if it exists on the cache folder else will return data folder

Definition at line 121 of file Globals.cs.

Here is the caller graph for this function:

Member Data Documentation

◆ Cache

const string QuantConnect.Globals.Cache = "./cache/data"
static

The directory used for storing downloaded remote files

Definition at line 106 of file Globals.cs.

Property Documentation

◆ Api

string QuantConnect.Globals.Api
staticgetset

The base api url address to use

Definition at line 36 of file Globals.cs.

◆ UserId

int QuantConnect.Globals.UserId
staticgetset

The user Id

Definition at line 41 of file Globals.cs.

◆ ProjectId

int QuantConnect.Globals.ProjectId
staticgetset

The project id

Definition at line 46 of file Globals.cs.

◆ UserToken

string QuantConnect.Globals.UserToken
staticgetset

The user token

Definition at line 51 of file Globals.cs.

◆ OrganizationID

string QuantConnect.Globals.OrganizationID
staticgetset

The organization id

Definition at line 56 of file Globals.cs.

◆ ResultsDestinationFolder

string QuantConnect.Globals.ResultsDestinationFolder
staticgetset

The results destination folder

Definition at line 61 of file Globals.cs.

◆ DataFolder

string QuantConnect.Globals.DataFolder
staticget

The root directory of the data folder for this application

Definition at line 66 of file Globals.cs.

◆ LiveMode

bool QuantConnect.Globals.LiveMode
staticget

True if running in live mode

Definition at line 71 of file Globals.cs.

◆ Version

string QuantConnect.Globals.Version
staticget

The version of lean

Definition at line 111 of file Globals.cs.

◆ CacheDataFolder

string QuantConnect.Globals.CacheDataFolder
staticget

Data path to cache folder location

Definition at line 116 of file Globals.cs.


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