Generated on Sat Feb 7 2015 02:01:42 for Gecode by doxygen 1.8.9.1
Gecode::Driver::StringOption Class Reference

String-valued option (integer value defined by strings) More...

#include <driver.hh>

Classes

class  Value
 Option value. More...
 

Public Member Functions

 StringOption (const char *o, const char *e, int v=0)
 Initialize for option o and explanation e and default value v. More...
 
void value (int v)
 Set default value to v. More...
 
int value (void) const
 Return current option value. More...
 
void add (int v, const char *o, const char *h=NULL)
 Add option value for value v, string o, and help text h. More...
 
virtual int parse (int argc, char *argv[])
 Parse option at first position and return number of parsed arguments. More...
 
virtual void help (void)
 Print help text. More...
 
virtual ~StringOption (void)
 Destructor. More...
 
- Public Member Functions inherited from Gecode::Driver::BaseOption
 BaseOption (const char *o, const char *e)
 Initialize for option o and explanation e. More...
 
virtual ~BaseOption (void)
 Destructor. More...
 

Protected Attributes

int cur
 Current value. More...
 
Valuefst
 First option value. More...
 
Valuelst
 Last option value. More...
 
- Protected Attributes inherited from Gecode::Driver::BaseOption
const char * opt
 String for option (including hyphen) More...
 
const char * exp
 Short explanation. More...
 
BaseOptionnext
 Next option Check for option and return its argument. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Gecode::Driver::BaseOption
static char * strdup (const char *s)
 Create heap-allocated copy of string s. More...
 
static void strdel (const char *s)
 Delete heap-allocated copy of string s. More...
 
- Protected Member Functions inherited from Gecode::Driver::BaseOption
char * argument (int argc, char *argv[]) const
 

Detailed Description

String-valued option (integer value defined by strings)

Definition at line 174 of file driver.hh.

Constructor & Destructor Documentation

Gecode::Driver::StringOption::StringOption ( const char *  o,
const char *  e,
int  v = 0 
)
inline

Initialize for option o and explanation e and default value v.

Definition at line 59 of file options.hpp.

Gecode::Driver::StringOption::~StringOption ( void  )
virtual

Destructor.

Definition at line 169 of file options.cpp.

Member Function Documentation

void Gecode::Driver::StringOption::value ( int  v)
inline

Set default value to v.

Definition at line 62 of file options.hpp.

int Gecode::Driver::StringOption::value ( void  ) const
inline

Return current option value.

Definition at line 66 of file options.hpp.

void Gecode::Driver::StringOption::add ( int  v,
const char *  o,
const char *  h = NULL 
)

Add option value for value v, string o, and help text h.

Definition at line 121 of file options.cpp.

int Gecode::Driver::StringOption::parse ( int  argc,
char *  argv[] 
)
virtual

Parse option at first position and return number of parsed arguments.

Implements Gecode::Driver::BaseOption.

Definition at line 135 of file options.cpp.

void Gecode::Driver::StringOption::help ( void  )
virtual

Print help text.

Implements Gecode::Driver::BaseOption.

Definition at line 150 of file options.cpp.

Member Data Documentation

int Gecode::Driver::StringOption::cur
protected

Current value.

Definition at line 184 of file driver.hh.

Value* Gecode::Driver::StringOption::fst
protected

First option value.

Definition at line 185 of file driver.hh.

Value* Gecode::Driver::StringOption::lst
protected

Last option value.

Definition at line 186 of file driver.hh.


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