class CmdLine

This class provides a useful interface for the user, to easily read some arguments/options from the command-line.

Inheritance:

Public Methods

CmdLine()

int read(int argc_, char** argv_)

Read the command-line.

void help()

Print the help.

void addBCmdOption(const char* name, bool* ptr, bool init_value, const char* help="", bool save_it=false)

void addRCmdOption(const char* name, real* ptr, real init_value, const char* help="", bool save_it=false)

void addSCmdOption(const char* name, char** ptr, const char* init_value, const char* help="", bool save_it=false)

void addBCmdArg(const char* name, bool* ptr, const char* help="", bool save_it=false)

void addRCmdArg(const char* name, real* ptr, const char* help="", bool save_it=false)

void addSCmdArg(const char* name, char** ptr, const char* help="", bool save_it=false)

void addText(const char* text)

Add a text line in the help message

void info(const char* text)

Add a text at the beginnig of the help

void addMasterSwitch(const char* text)

Add a master switch.

void setWorkingDirectory(const char* dirname)

Set the working directory.

char* getPath(const char* filename)

Get a full path.

DiskXFile* getXFile(const char* filename)

Get a DiskXFile.

virtual void loadXFile(XFile* file)

Load the object from a file pointer (not the options)

virtual void saveXFile(XFile* file)

Save the object to a file pointer (not the options)

void addCmdOption(CmdOption* option)

Add an option to the command line.

void writeLog(XFile* file, bool write_associated_files)

Write a log in file.

Public Members

Functions for adding options.

Functions for adding an argument.

Inherited from Object:

Public Fields

Allocator* allocator

Public Methods

void addOption(const char* name, int size, void* ptr, const char* help="")

void addIOption(const char* name, int* ptr, int init_value, const char* help="")

void addROption(const char* name, real* ptr, real init_value, const char* help="")

void addBOption(const char* name, bool* ptr, bool init_value, const char* help="")

void addOOption(const char* name, Object** ptr, Object* init_value, const char* help="")

void setOption(const char* name, void* ptr)

void setIOption(const char* name, int option)

void setROption(const char* name, real option)

void setBOption(const char* name, bool option)

void setOOption(const char* name, Object* option)

void load(const char* filename)

void save(const char* filename)

void* operator new(size_t size, Allocator* allocator_=NULL)

void* operator new(size_t size, Allocator* allocator_, void* ptr_)

void operator delete(void* ptr)

Documentation

This class provides a useful interface for the user, to easily read some arguments/options from the command-line.

Note that here, we make a difference between:

• options which are not required.
• arguments which are required.

Options:

"write log"

bool

Should I output the cmd.log file ?

[true]

CmdLine()

int read(int argc_, char** argv_)

Read the command-line. Call this function after adding options/arguments that you need, with the help of the following functions.

void help()

Print the help. Call this function after adding options/arguments that you need, with the help of the following functions.

Functions for adding options.

Functions for adding options. The calling order of the following functions will define the text order associated when you will call help().

Add an option (Int, Bool, Real, String).

• name the name of the option (must be unique).
• ptr is the pointer on the optional variable.
• init_value is the initialization value.
• help is the help text for this option.

The option will be setted to value in the command-line by printing "name value"

void addBCmdOption(const char* name, bool* ptr, bool init_value, const char* help="", bool save_it=false)

void addRCmdOption(const char* name, real* ptr, real init_value, const char* help="", bool save_it=false)

void addSCmdOption(const char* name, char** ptr, const char* init_value, const char* help="", bool save_it=false)

Functions for adding an argument.

Functions for adding an argument. The argument will be setted to value in the command-line by writting "value" after all the options. If there are N arguments, you have to write "value1 value2 value3 ... valueN" to set them in the command-line.

void addBCmdArg(const char* name, bool* ptr, const char* help="", bool save_it=false)

void addRCmdArg(const char* name, real* ptr, const char* help="", bool save_it=false)

void addSCmdArg(const char* name, char** ptr, const char* help="", bool save_it=false)

void addText(const char* text)

Add a text line in the help message

void info(const char* text)

Add a text at the beginnig of the help

void addMasterSwitch(const char* text)

Add a master switch. It creates an another type of command line. If the text is the first argument of the user command line, only the options corresponding to this new command line will be considered.

void setWorkingDirectory(const char* dirname)

Set the working directory. Use it with getPath() and getXFile().

char* getPath(const char* filename)

Get a full path. It adds the working_directory before the filename. This path will be deleted by CmdLine.

DiskXFile* getXFile(const char* filename)

Get a DiskXFile. It adds the working_directory before the filename and opens the file. This XFile will be deleted by CmdLine.

virtual void loadXFile(XFile* file)

Load the object from a file pointer (not the options)

virtual void saveXFile(XFile* file)

Save the object to a file pointer (not the options)

void addCmdOption(CmdOption* option)

Add an option to the command line. Use this method if the wrappers that are provided are not sufficient.

void writeLog(XFile* file, bool write_associated_files)

Write a log in file. If desired, the associated files can be printed.

This class has no child classes.

Author:

Ronan Collobert (collober@idiap.ch)

See Also:

CmdOption

Alphabetic index HTML hierarchy of classes or Java