BoolParameter Class Reference

#include <BoolParameter.h>

Inheritance diagram for BoolParameter:

Inheritance graph
[legend]
Collaboration diagram for BoolParameter:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual int setValue (char *val)
 BoolParameter (char *name_, char *help_, char *prompt_, bool Default_)
virtual char * toString ()
virtual char * toString (char *infix)
char * getName ()
char * getValueString ()

Public Attributes

bool Default
char * help
char * prompt
bool value

Private Member Functions

char * getValueString (bool v)


Detailed Description

This interface is DEPRECATED. Boolean parameter class.

Member Function Documentation

virtual int BoolParameter::setValue ( char *  val  )  [virtual]

Good implementations will take the following, if prompting for text (case insensitive, of course): / 0 <-- no, nyet, zip, nada, f, FALSE, 0, n, wrong, buzz / 1 <-- yes, da, yep, y, si, t, TRUE, 1, right, correct, ok, ding!

Implements BaseParameter.

virtual char* BoolParameter::toString (  )  [virtual]

Get the bounds, etc as a curiously formatted string

Implements BaseParameter.

virtual char* BoolParameter::toString ( char *  infix  )  [virtual]

Return the string form of the parameter using infix as part of the formatting. We own this string.

Implements BaseParameter.

char* BoolParameter::getName (  )  [inline, virtual]

Return the simple string (no whitespace) name/key identifying this parameter uniquely within a collection of parameters. We own this string; don't free it.

Implements BaseParameter.

00031 { return name; }

char* BoolParameter::getValueString (  )  [virtual]

Get value printed into a string in the usual way. We own this string; don't free it (or keep it beyond the life of the parameter object). In some obscure cases, this may come back as "UNDEFINED".

Implements BaseParameter.


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

Generated on Thu Sep 17 08:21:18 2009 for CCAFFEINE by  doxygen 1.5.9