Diffpack Documentation

---

              Search  

---

MenuAnswerTable Class Reference

table of "MenuAnswer" objects. More...

#include <MenuAnswerTable.h>

List of all members.

Public Methods
	MenuAnswerTable ()
	~MenuAnswerTable ()
void	append (MenuAnswer &answer)
void	destroyListAndPrepareLoop ()
int	getNoCombinations ()
void	realizeAnswers (int combination)
void	collectCommands (StringList &command_list)
void	collectCurrentAnswers (StringList &answer_list)
void	writeExtendedResults (MultipleReporter &rep, int section_level=1)
void	makeMultipleLoopPrmFile (const String &filename, int loop_no)
void	debugPrint ()
void	loopTest ()
void	reset ()

---

Detailed Description

table of "MenuAnswer" objects.

NAME: MenuAnswerTable - table of "MenuAnswer" objects

DESCRIPTION:

The class organizes "MultipleAnswer" objects in a table. This table is central in the multiple loop functionality of class "MenuSystem". The example below demonstrates the usage of the class. First, a set of multiple answers are appended to the table. Then the table is processed and a multiple loop is set up. The "loopTest" functions executes a multiple loop (like "MenuSystem multipleLoop") and and keeps track of the various combinations of the menu answers.

---

Constructor & Destructor Documentation

MenuAnswerTable::MenuAnswerTable ( )

There in only one, default constructor.

MenuAnswerTable::~MenuAnswerTable ( )

---

Member Function Documentation

void MenuAnswerTable::append ( MenuAnswer & answer )

appends a "MenuAnswer" object at the end of the list used to build the answer table.

void MenuAnswerTable::collectCommands ( StringList & command_list )

collects all menu commands that have multiple answers and preceed them by the keyword ""ML: "".

void MenuAnswerTable::collectCurrentAnswers ( StringList & answer_list )

collects the current answer from all menu items with multiple answers.

void MenuAnswerTable::debugPrint ( )

prints debug information. (For internal use only).

void MenuAnswerTable::destroyListAndPrepareLoop ( )

destroys the list, generates the table of "MenuAnswer" objects and prepares for a multiple loop.

int MenuAnswerTable::getNoCombinations ( ) [inline]

return the number of input combinations in the current table. This function depends on "destroyListAndPrepareLoop" being called first.

void MenuAnswerTable::loopTest ( )

void MenuAnswerTable::makeMultipleLoopPrmFile ( const String & filename, int loop_no )

makes a special file containing the parameters that are varied in the multiple loop and their particular values in this run.

void MenuAnswerTable::realizeAnswers ( int combination )

extracts the current input combination (number "combination") from the table.

void MenuAnswerTable::reset ( )

completely resets the answer table.

void MenuAnswerTable::writeExtendedResults ( MultipleReporter & rep, int section_level = 1 )

writes menu answer information in a format suitable for "MultipleReporter".

---

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

• MenuAnswerTable.h

---