casacore::Choice Class Reference

Class to ask a user a choice. More...

#include <Choice.h>

Public Types
typedef String	ChoiceFunc (const String &descriptiveText, const Vector< String > &choices)
	Define the signature of the choice function.
Static Public Member Functions
static String	choice (const String &descriptiveText, const Vector< String > &choices)
	Get a choice from the user.
static ChoiceFunc *	setChoiceFunc (ChoiceFunc *func)
	Set the choice function.
static String	stderrChoice (const String &descriptiveText, const Vector< String > &choices)
	A choice function asking on stderr.
static String	stdoutChoice (const String &descriptiveText, const Vector< String > &choices)
	A choice function asking on stdout.
Static Private Member Functions
static String	ostreamChoice (std::ostream &, const String &descriptiveText, const Vector< String > &choices)
	Ask on an ostream.
Static Private Attributes
static ChoiceFunc *	theirChoiceFunc

Detailed Description

Class to ask a user a choice.

Review Status

Date Reviewed:: yyyy/mm/dd

Etymology

Synopsis

Definition at line 59 of file Choice.h.

Member Typedef Documentation

typedef String casacore::Choice::ChoiceFunc(const String &descriptiveText, const Vector< String > &choices)

Define the signature of the choice function.

Definition at line 63 of file Choice.h.

Member Function Documentation

static String casacore::Choice::choice	(	const String &	descriptiveText,
		const Vector< String > &	choices
	)			`[static]`

Get a choice from the user.

The choice function to be used can be set using setChoiceFunc. It can, for instance, be done by ObjectController. Initially no choice function is set. In that case it returns the first choice (so that should be the default choice). If choices is zero length, an empty string is returned.

static String casacore::Choice::ostreamChoice	(	std::ostream &	,
		const String &	descriptiveText,
		const Vector< String > &	choices
	)			`[static, private]`

Ask on an ostream.

Referenced by stderrChoice(), and stdoutChoice().

static ChoiceFunc* casacore::Choice::setChoiceFunc ( ChoiceFunc * func ) [static]

Set the choice function.

It returns the old choice function.

static String casacore::Choice::stderrChoice	(	const String &	descriptiveText,
		const Vector< String > &	choices
	)			`[inline, static]`

A choice function asking on stderr.

Definition at line 80 of file Choice.h.

References ostreamChoice().

static String casacore::Choice::stdoutChoice	(	const String &	descriptiveText,
		const Vector< String > &	choices
	)			`[inline, static]`

A choice function asking on stdout.

It outputs the descriptiveText followed by a blank, the options (enclosed in parentheses) and a colon. The default option is shown in square brackets.

Definition at line 88 of file Choice.h.

References ostreamChoice().