paramxx  1.0.7
StringPar Class Reference

#include <StringPar.h>

+ Inheritance diagram for StringPar:
+ Collaboration diagram for StringPar:

Public Member Functions

 StringPar (const StringPar &par)
 
 StringPar (ParTxt &par) throw ( ParFileException )
 
void pgetstr (char result[], size_t size) const throw ( ParFileException )
 only defined in LongPar More...
 
string pgetstring () const throw ( ParFileException )
 only defined in StringPar More...
 
void print (ostream &os) const
 
void set_val (const string &str) throw ( ParFileException, Exception )
 
- Public Member Functions inherited from Par
virtual ~Par (void)
 
 Par (void)
 
 Par (ParTxt &par)
 
int check_value (const char *str) const
 
virtual void plist (ostream &os) const
 
string get_name (void) const
 
string get_mode (void) const
 
string get_prompt (void) const
 
string get_value (void) const
 
virtual bool pgetb (void) const throw ( ParFileException )
 
virtual double pgetd (void) const throw ( ParFileException )
 only defined in BoolPar More...
 
virtual int pgeti (void) const throw ( ParFileException )
 only defined in RealPar More...
 
virtual long pgetl (void) const throw ( ParFileException )
 only defined in LongPar More...
 

Additional Inherited Members

- Public Types inherited from Par
enum  ParFileDelimit { DELIMIT =',' }
 
enum  ParType {
  PARNAME, PARTYPE, PARMODE, PARVALUE,
  PARMINIMUM, PARMAXIMUM, PARPROMPT
}
 
enum  ParamMode {
  AUTOS ='a', BATCH ='b', hIDDEN ='h', HIDDEN ='H',
  QUERRY ='q', LEARN ='l'
}
 
enum  ParamType {
  BOOLEAN ='b', COMMENT ='c', INTEGER ='i', REAL ='r',
  STRING ='s'
}
 
enum  NumTokens { NUMTOKENS =7 }
 
- Static Public Member Functions inherited from Par
static int my_tokenize (char *str, char *delimit, char ***tokens) throw ( Exception )
 
static void delete_tokens (char **ptr)
 
static bool is_indirrect (const string &str, char delimit=')')
 
- Protected Member Functions inherited from Par
void not_between_limits (char str[], const char *left, const string &left_val, const char *right, const string &right_val) const
 
- Protected Attributes inherited from Par
vector< string > parameter
 

Detailed Description

A string parameter. The class is reponsible to make sure that the parameter can only take a string value.

Constructor & Destructor Documentation

◆ StringPar()

StringPar::StringPar ( const StringPar par)
inline

The copy constructor.

Member Function Documentation

◆ pgetstr()

void StringPar::pgetstr ( char  result[],
size_t  size 
) const
throw (ParFileException
)
inlinevirtual

only defined in LongPar

Reimplemented from Par.

References Par::PARVALUE.

◆ pgetstring()

string StringPar::pgetstring ( void  ) const
throw (ParFileException
)
inlinevirtual

only defined in StringPar

Reimplemented from Par.

References Par::PARVALUE, and print().

◆ print()

void StringPar::print ( ostream &  os) const
virtual

To output the parameter of the form: name,type,mode,"val",min,max,prompt

Reimplemented from Par.

References Par::PARMODE, and Par::PARVALUE.

Referenced by pgetstring().


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