Tramway SDK
Classes | Enumerations | Functions | Variables
tram::Settings Namespace Reference

Application setting management and CLI command parser. More...

Classes

struct  Property
 
struct  RawSetting
 
struct  SettingInfo
 

Enumerations

enum  : uint32_t { USER = 1 , APPLICATION = 2 , MENU = 4 , NONE = 0 }
 

Functions

void SetFromRaw (SettingInfo &info)
 
void SetAndStore (SettingInfo info)
 
void Register (bool &value, const char *name, uint32_t flags)
 
void Register (float &value, const char *name, uint32_t flags)
 
void Register (int32_t &value, const char *name, uint32_t flags)
 
void Register (uint32_t &value, const char *name, uint32_t flags)
 
Value Get (name_t name)
 
void Set (name_t name, Value value)
 
void Parse (const char **argv, int argc)
 
uint32_t Flags (name_t name)
 
std::vector< name_tGetSettings (uint32_t filter)
 
void Save (const char *file)
 
void Load (const char *file)
 

Variables

const int SETTING_LIMIT = 200
 

Detailed Description

Application setting management and CLI command parser.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum : uint32_t
Enumerator
USER 
APPLICATION 
MENU 
NONE 

Function Documentation

◆ Flags()

uint32_t tram::Settings::Flags ( name_t  name)

◆ Get()

Value tram::Settings::Get ( name_t  name)

◆ GetSettings()

std::vector< name_t > tram::Settings::GetSettings ( uint32_t  filter)

◆ Load()

void tram::Settings::Load ( const char *  file)

◆ Parse()

void tram::Settings::Parse ( const char **  argv,
int  argc 
)

◆ Register() [1/4]

void tram::Settings::Register ( bool &  value,
const char *  name,
uint32_t  flags 
)

◆ Register() [2/4]

void tram::Settings::Register ( float &  value,
const char *  name,
uint32_t  flags 
)

◆ Register() [3/4]

void tram::Settings::Register ( int32_t &  value,
const char *  name,
uint32_t  flags 
)

◆ Register() [4/4]

void tram::Settings::Register ( uint32_t &  value,
const char *  name,
uint32_t  flags 
)

◆ Save()

void tram::Settings::Save ( const char *  file)

◆ Set()

void tram::Settings::Set ( name_t  name,
Value  value 
)

◆ SetAndStore()

void tram::Settings::SetAndStore ( SettingInfo  info)

◆ SetFromRaw()

void tram::Settings::SetFromRaw ( SettingInfo info)

Variable Documentation

◆ SETTING_LIMIT

const int tram::Settings::SETTING_LIMIT = 200