base::ConfTxt Class Reference

Template Method to read human-editable textual conf file via C++ stream. More...

#include <_src_base_conf_txt.hh>

Inheritance diagram for base::ConfTxt:

List of all members.

Public Member Functions
	ConfTxt (void)
virtual	~ConfTxt ()
void	Read (const string &pathname)
virtual void	ProcessField (string &field, ifstream &config)=0

---

Detailed Description

Template Method to read human-editable textual conf file via C++ stream.

--- MIGHT THROW AN EXCEPTION ---

A configuration file is similar to a UNIX /etc file. ConfTxt::Read() is a Template Method that is responsble for:

• Opening and closing a file via a C++ stream.
• Getting the next field (word) and passing it as a C++ string to ProcessField() of the client/derivative.
• Filtering away comments. Comments are prefixed by '#' (UNIX /etc convention).

Read() allows the derivative of ProcessField(string& field, ifstream& conf) to modify both passed args.

---

Constructor & Destructor Documentation

base::ConfTxt::ConfTxt

(

void

)

ctor/dtor. Actual code is at Read() instead of ctor because the virtual method ProcessField() has to be called.

base::ConfTxt::~ConfTxt

(

)

[virtual]

---

Member Function Documentation

void base::ConfTxt::Read

(

const string &

pathname

)

Read configuration and either parse or defer fields.

--- MIGHT THROW AN EXCEPTION ---

Read() allows the derivative of ProcessField(string& field, ifstream& conf) to modify both passed args.

virtual void base::ConfTxt::ProcessField	(	string &	field,
		ifstream &	config
	)			[pure virtual]

Implemented in base::Conf::ModuleConfTxt, control::Conf::ModuleConfTxt, fx::Conf::ModuleConfTxt, graph::Conf::ModuleConfTxt, hud::Conf::ModuleConfTxt, input::Conf::ModuleConfTxt, physics::AircraftSpecsConfTxt, physics::Conf::ModuleConfTxt, program::Conf::ModuleConfTxt, shader::Conf::ModuleConfTxt, sky::Conf::ModuleConfTxt, sound::Conf::ModuleConfTxt, view::Conf::ModuleConfTxt, and world::Conf::ModuleConfTxt.

---

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

• _src_base_conf_txt.hh
• _src_base_conf_txt.cc