LoConfigHelpers.H File Reference

Helper/convenience functions for accessing the lobot configuration database. More...

#include "Robots/LoBot/config/LoConfig.H"
#include "Robots/LoBot/config/LoDefaults.H"
#include "Robots/LoBot/misc/LoTypes.H"
#include "Robots/LoBot/util/LoString.H"
#include "Robots/LoBot/util/triple.hh"
#include "Robots/LoBot/util/range.hh"
#include <string>
#include <utility>

Include dependency graph for LoConfigHelpers.H:

Go to the source code of this file.

Functions
template<typename T >
T	lobot::get_conf (const std::string &section, const std::string &key, const T &default_value=T())
template<>
PixelType	lobot::get_conf (const std::string &section, const std::string &key, const PixelType &defval)
template<typename T >
std::pair< T, T >	lobot::get_conf (const std::string &section, const std::string &key, const std::pair< T, T > &defval=std::pair< T, T >(T(), T()))
template<typename T >
triple< T, T, T >	lobot::get_conf (const std::string &section, const std::string &key, const triple< T, T, T > &defval=make_triple(T(), T(), T()))
template<typename T >
range< T >	lobot::get_conf (const std::string &section, const std::string &key, const range< T > &defval=range< T >(T(), T()))
template<typename T >
T	lobot::global_conf (const std::string &key, const T &default_value=T())
	Retrieve settings from the global section of the config file.
template<typename T >
T	lobot::internal_conf (const std::string &key, const T &default_value=T())
template<typename T >
T	lobot::robot_conf (const std::string &key, const T &default_value=T())
	Retrieve settings from the motor section of the config file.
bool	lobot::robot_enabled ()
	Does the user want to enable the physical robot?
std::string	lobot::robot_platform ()
	Which robot platform will Robolocust be running on?
bool	lobot::robot_platform_is_roomba ()
	Is the lobot controller running on an iRobot Create/Roomba?
std::string	lobot::locust_input ()
	Check what input source to use for the locust LGMD spikes.
bool	lobot::video_input ()
	Check if cameras are being used to generate LGMD spikes.
bool	lobot::laser_input ()
	Check if the laser range finder is being used to generate LGMD spikes.
template<typename T >
T	lobot::laser_conf (const std::string &key, const T &default_value=T())
	Retrieve settings from the laser section of the config file.
std::string	lobot::locust_model ()
	Check which LGMD model is being used.
template<typename T >
T	lobot::ui_conf (const std::string &key, const T &default_value=T())
	Retrieve settings from the ui section of the config file.
bool	lobot::visualize (const std::string &section)
template<typename T >
T	lobot::video_conf (const std::string &key, const T &default_value=T())
	Retrieve settings from the video section of the config file.
template<typename T >
T	lobot::optical_flow_conf (const std::string &key, const T &default_value)
	Retrieve settings from the optical flow section of the config file.

---

Detailed Description

Helper/convenience functions for accessing the lobot configuration database.

This file defines several functions that can be used to ease the interface to lobot's configuration database. Thus, clients may, for instance, simply use the get_conf() function and not have to worry about invoking Configuration::get(); so on and so forth.

Basically, this file provides a bunch of helpers that result less typing and less ceremony in client code for using the configuration database.

Definition in file LoConfigHelpers.H.