mapgd  0.4
A program for the Maximum-likelihood analysis of population genomic data.
 All Data Structures Functions Variables Friends Groups Pages
Public Member Functions | Data Fields
Argument Class Reference

A command line argument. See the interface tutorial for a demonstration of usage. More...

#include <interface.h>

Public Member Functions

 Argument (const char opt_, char *lopt_, void *parm_, int(*func_)(int, char **, void *), char *emsg_, char *umsg_)
 The default constructor for an argument. More...
 
template<class Type >
 Argument (const char opt_, char *lopt_, Type &parm_, char *emsg_, char *umsg_)
 

Data Fields

bool set
 flag toggles whether option has been set.
 
bool required
 flag toggles whether option is required.
 
char opt
 the option name.
 
char * lopt
 the long option name.
 
void * parm
 pointer to the parameter to be set.
 
int(* func )(int, char **, void *)
 the function to set the parameters.
 
char * emsg
 A short error message to display when the proper parameters aren't passed to this option.
 
char * umsg
 
char * operand_type
 A short description of this option to be displayed in the usage message.
 

Detailed Description

A command line argument. See the interface tutorial for a demonstration of usage.

Constructor & Destructor Documentation

Argument::Argument ( const char  opt_,
char *  lopt_,
void *  parm_,
int(*)(int, char **, void *)  func_,
char *  emsg_,
char *  umsg_ 
)
inline

The default constructor for an argument.

This desperately needs to be changed because passing a void pointer prevents the compiler from checking that we pass the right type, which causes no end of problems.

Field Documentation

char* Argument::umsg

A short description of this option to be displayed in the usage message.


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