LongParameter Class Reference

#include <LongParameter.h>

Inheritance diagram for LongParameter:

Inheritance graph
[legend]
Collaboration diagram for LongParameter:

Collaboration graph
[legend]

List of all members.

Public Member Functions

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

Public Attributes

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


Detailed Description

This interface is DEPRECATED. Long integer parameter class.

Member Function Documentation

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

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

Implements BaseParameter.

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

Get the bounds, etc as a curiously formatted string

Implements BaseParameter.

virtual char* LongParameter::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* LongParameter::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* LongParameter::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 Tue Apr 28 03:12:56 2009 for CCAFFEINE by  doxygen 1.5.5