bdm::UI Class Reference

UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo<T> or Particular_UI<T> instead. The raison d'etre of this class is to allow pointers to its templated descendants. More...

#include <user_info.h>

List of all members.

Classes
class	Class_To_UI
class	Link_Expander
Static Public Member Functions
static void	ui_error (string message, const Setting &element)
template<class T >
static T *	build (Setting &element, const int index)
	Prototype of a UI builder. Return value is by the second argument since it type checking via dynamic_cast.
template<class T >
static T *	build (Setting &element, const string &name)
template<class T >
static void	save (T &instance, Setting &element, const string &name="")
static bool	get (mat &matrix, const Setting &element, const string &name)
	This methods tries to build a new double matrix.
static bool	get (mat &matrix, const Setting &element, const int index)
	This methods tries to build a new double matrix.
static void	save (mat &matrix, Setting &element, const string &name="")
	This methods tries to save a double matrix.
static bool	get (ivec &vec, const Setting &element, const string &name)
	This methods tries to build a new double vec.
static bool	get (ivec &vec, const Setting &element, const int index)
	This methods tries to build a new double vec.
static void	save (ivec &vec, Setting &element, const string &name="")
	This methods tries to save a double vec.
static bool	get (Array< string > &string_array, const Setting &element, const string &name)
	This methods tries to build a new double string_array.
static bool	get (Array< string > &string_array, const Setting &element, const int index)
	This methods tries to build a new double string_array.
static void	save (Array< string > &string_array, Setting &element, const string &name="")
	This methods tries to save a double string_array.
Protected Member Functions
	UI (const string &class_name)
	default constructor
virtual	~UI ()
	Virtual destructor for future use;.

---

Detailed Description

UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo<T> or Particular_UI<T> instead. The raison d'etre of this class is to allow pointers to its templated descendants.

Also, the main functions of the whole UserInfo library are included within this class, see static methods 'build' and 'save'.

/*!Builds computational object from a UserInfo structureReturn value is a pointer to the created object (memory management issue?) /

---

Member Function Documentation

template<class T >

static T* bdm::UI::build	(	Setting &	element,
		const int	index
	)			[inline, static]

Prototype of a UI builder. Return value is by the second argument since it type checking via dynamic_cast.

This methods tries to build a new instance of type T (or some of its descendant types) according to a data stored in a DOMNode named class_name within a child nodes of the passed element. If an ui_error occurs, it returns a NULL pointer.

template<class T >

static void bdm::UI::save	(	T &	instance,
		Setting &	element,
		const string &	name = ""
	)			[inline, static]

This methods tries to save an instance of type T (or some of its descendant types) and build DOM tree accordingly. Then, it creates a new DOMNode named according class_name and connecti it to the passed Setting as a new child node.

---

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

• user_info.h