NASA Astrobee Robot Software  0.19.1
Flight software for the Astrobee robots operating inside the International Space Station.
config_reader::ConfigReader Class Reference

#include <config_reader.h>

Classes

class  FileHeader
 
class  Table
 

Public Types

enum  FileFlags { Optional = 1<<0 }
 

Public Member Functions

 ConfigReader ()
 
 ConfigReader (const char *path)
 
 ~ConfigReader ()
 
void Close ()
 
void Reset ()
 
bool IsOpen ()
 
void SetPath (const char *path)
 
void AddFile (const char *filename, unsigned flags=0)
 
bool ReadFiles ()
 
bool IsFileModified ()
 
void CheckFilesUpdated (std::function< void(void)>)
 
bool CheckValExists (const char *exp)
 
bool GetTable (const char *exp, Table *table)
 
bool GetStr (const char *exp, std::string *str)
 
bool GetBool (const char *exp, bool *val)
 
bool GetInt (const char *exp, int *val)
 
bool GetLongLong (const char *exp, int64_t *val)
 
bool GetUInt (const char *exp, unsigned int *val)
 
bool GetReal (const char *exp, float *val)
 
bool GetReal (const char *exp, double *val)
 
bool GetPosReal (const char *exp, float *val)
 
bool GetPosReal (const char *exp, double *val)
 
bool GetInt (const char *exp, int *val, int min, int max)
 
bool GetReal (const char *exp, float *val, float min, float max)
 
bool GetReal (const char *exp, double *val, double min, double max)
 

Protected Member Functions

bool InitLua ()
 
void CloseLua ()
 
void ClearWatches ()
 
void ShowError (int err_code, const char *filename)
 
bool ReadFile (const char *filename, unsigned flags)
 
void AddImports ()
 
void AddStandard ()
 
bool PutObjectOnLuaStack (const char *exp)
 
bool PutObjectOnLuaStack (const char *exp, int ref)
 
bool PutObjectOnLuaStack (int index, int ref)
 
bool IsTopValid ()
 
void OutputGetValueError (const char *exp, const char *type)
 
bool ReadTable (const char *exp, Table *table)
 
bool ReadStr (const char *exp, std::string *str)
 
bool ReadBool (const char *exp, bool *val)
 
bool ReadInt (const char *exp, int *val)
 
bool ReadLongLong (const char *exp, int64_t *val)
 
bool ReadUInt (const char *exp, unsigned int *val)
 
bool ReadReal (const char *exp, float *val)
 
bool ReadReal (const char *exp, double *val)
 
bool ReadPosReal (const char *exp, float *val)
 
bool ReadPosReal (const char *exp, double *val)
 
bool ReadInt (const char *exp, int *val, int min, int max)
 
bool ReadReal (const char *exp, float *val, float min, float max)
 
bool ReadReal (const char *exp, double *val, double min, double max)
 
bool IsNumber ()
 

Protected Attributes

std::vector< FileHeaderfiles_
 
lua_State * l_
 
WatchFiles watch_files_
 
bool modified_
 
std::string path_
 

Member Enumeration Documentation

◆ FileFlags

Enumerator
Optional 

Constructor & Destructor Documentation

◆ ConfigReader() [1/2]

config_reader::ConfigReader::ConfigReader ( )

◆ ConfigReader() [2/2]

config_reader::ConfigReader::ConfigReader ( const char *  path)
explicit

◆ ~ConfigReader()

config_reader::ConfigReader::~ConfigReader ( )

Member Function Documentation

◆ AddFile()

void config_reader::ConfigReader::AddFile ( const char *  filename,
unsigned  flags = 0 
)

◆ AddImports()

void config_reader::ConfigReader::AddImports ( )
protected

◆ AddStandard()

void config_reader::ConfigReader::AddStandard ( )
protected

◆ CheckFilesUpdated()

void config_reader::ConfigReader::CheckFilesUpdated ( std::function< void(void)>  callback)

◆ CheckValExists()

bool config_reader::ConfigReader::CheckValExists ( const char *  exp)

◆ ClearWatches()

void config_reader::ConfigReader::ClearWatches ( )
protected

◆ Close()

void config_reader::ConfigReader::Close ( )

◆ CloseLua()

void config_reader::ConfigReader::CloseLua ( )
protected

◆ GetBool()

bool config_reader::ConfigReader::GetBool ( const char *  exp,
bool *  val 
)

◆ GetInt() [1/2]

bool config_reader::ConfigReader::GetInt ( const char *  exp,
int *  val 
)

◆ GetInt() [2/2]

bool config_reader::ConfigReader::GetInt ( const char *  exp,
int *  val,
int  min,
int  max 
)

◆ GetLongLong()

bool config_reader::ConfigReader::GetLongLong ( const char *  exp,
int64_t *  val 
)

◆ GetPosReal() [1/2]

bool config_reader::ConfigReader::GetPosReal ( const char *  exp,
double *  val 
)

◆ GetPosReal() [2/2]

bool config_reader::ConfigReader::GetPosReal ( const char *  exp,
float *  val 
)

◆ GetReal() [1/4]

bool config_reader::ConfigReader::GetReal ( const char *  exp,
double *  val 
)

◆ GetReal() [2/4]

bool config_reader::ConfigReader::GetReal ( const char *  exp,
double *  val,
double  min,
double  max 
)

◆ GetReal() [3/4]

bool config_reader::ConfigReader::GetReal ( const char *  exp,
float *  val 
)

◆ GetReal() [4/4]

bool config_reader::ConfigReader::GetReal ( const char *  exp,
float *  val,
float  min,
float  max 
)

◆ GetStr()

bool config_reader::ConfigReader::GetStr ( const char *  exp,
std::string *  str 
)

◆ GetTable()

bool config_reader::ConfigReader::GetTable ( const char *  exp,
Table table 
)

◆ GetUInt()

bool config_reader::ConfigReader::GetUInt ( const char *  exp,
unsigned int *  val 
)

◆ InitLua()

bool config_reader::ConfigReader::InitLua ( )
protected

◆ IsFileModified()

bool config_reader::ConfigReader::IsFileModified ( )

◆ IsNumber()

bool config_reader::ConfigReader::IsNumber ( )
protected

◆ IsOpen()

bool config_reader::ConfigReader::IsOpen ( )

◆ IsTopValid()

bool config_reader::ConfigReader::IsTopValid ( )
protected

◆ OutputGetValueError()

void config_reader::ConfigReader::OutputGetValueError ( const char *  exp,
const char *  type 
)
protected

◆ PutObjectOnLuaStack() [1/3]

bool config_reader::ConfigReader::PutObjectOnLuaStack ( const char *  exp)
protected

◆ PutObjectOnLuaStack() [2/3]

bool config_reader::ConfigReader::PutObjectOnLuaStack ( const char *  exp,
int  ref 
)
protected

◆ PutObjectOnLuaStack() [3/3]

bool config_reader::ConfigReader::PutObjectOnLuaStack ( int  index,
int  ref 
)
protected

◆ ReadBool()

bool config_reader::ConfigReader::ReadBool ( const char *  exp,
bool *  val 
)
protected

◆ ReadFile()

bool config_reader::ConfigReader::ReadFile ( const char *  filename,
unsigned  flags 
)
protected

◆ ReadFiles()

bool config_reader::ConfigReader::ReadFiles ( )

◆ ReadInt() [1/2]

bool config_reader::ConfigReader::ReadInt ( const char *  exp,
int *  val 
)
protected

◆ ReadInt() [2/2]

bool config_reader::ConfigReader::ReadInt ( const char *  exp,
int *  val,
int  min,
int  max 
)
protected

◆ ReadLongLong()

bool config_reader::ConfigReader::ReadLongLong ( const char *  exp,
int64_t *  val 
)
protected

◆ ReadPosReal() [1/2]

bool config_reader::ConfigReader::ReadPosReal ( const char *  exp,
double *  val 
)
protected

◆ ReadPosReal() [2/2]

bool config_reader::ConfigReader::ReadPosReal ( const char *  exp,
float *  val 
)
protected

◆ ReadReal() [1/4]

bool config_reader::ConfigReader::ReadReal ( const char *  exp,
double *  val 
)
protected

◆ ReadReal() [2/4]

bool config_reader::ConfigReader::ReadReal ( const char *  exp,
double *  val,
double  min,
double  max 
)
protected

◆ ReadReal() [3/4]

bool config_reader::ConfigReader::ReadReal ( const char *  exp,
float *  val 
)
protected

◆ ReadReal() [4/4]

bool config_reader::ConfigReader::ReadReal ( const char *  exp,
float *  val,
float  min,
float  max 
)
protected

◆ ReadStr()

bool config_reader::ConfigReader::ReadStr ( const char *  exp,
std::string *  str 
)
protected

◆ ReadTable()

bool config_reader::ConfigReader::ReadTable ( const char *  exp,
Table table 
)
protected

◆ ReadUInt()

bool config_reader::ConfigReader::ReadUInt ( const char *  exp,
unsigned int *  val 
)
protected

◆ Reset()

void config_reader::ConfigReader::Reset ( )

◆ SetPath()

void config_reader::ConfigReader::SetPath ( const char *  path)

◆ ShowError()

void config_reader::ConfigReader::ShowError ( int  err_code,
const char *  filename 
)
protected

Member Data Documentation

◆ files_

std::vector<FileHeader> config_reader::ConfigReader::files_
protected

◆ l_

lua_State* config_reader::ConfigReader::l_
protected

◆ modified_

bool config_reader::ConfigReader::modified_
protected

◆ path_

std::string config_reader::ConfigReader::path_
protected

◆ watch_files_

WatchFiles config_reader::ConfigReader::watch_files_
protected

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