IntParameter Class Reference

#include <IntParameter.h>

Inheritance diagram for IntParameter:

Inheritance graph
[legend]
Collaboration diagram for IntParameter:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 IntParameter (char *name_, char *help_, char *prompt_, int Default_, int low_, int high_)
int setValue (char *val)
virtual char * toString ()
virtual char * toString (char *infix)
char * getName ()
char * getValueString ()

Public Attributes

int low
int high
int Default
char * name
char * help
char * prompt
int value


Detailed Description

This interface is DEPRECATED. integer parameter class.

Member Function Documentation

int IntParameter::setValue ( char *  value  )  [virtual]

parse the ascii form of the value. returns 0 if ok, -1 if error.

Implements BaseParameter.

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

Get the bounds, etc as a curiously formatted string

Implements BaseParameter.

virtual char* IntParameter::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* IntParameter::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* IntParameter::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 Mar 17 13:10:40 2011 for CCAFFEINE by  doxygen 1.5.9