Parameters.h

From Genome Analysis Wiki
Revision as of 03:22, 26 November 2009 by Goncalo (talk | contribs) (Created page with '''Parameters.h'' is a header file that defines a series of classes that are useful for processing command line parameters. == Example Usage == <source lang="cpp"> #include "…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Parameters.h is a header file that defines a series of classes that are useful for processing command line parameters.

Example Usage

 #include "Parameters.h"

 int main(int argc, char ** argv)
    {
    ParameterList pl;

    pl.Add(new IntParameter('n', "A number", aNumber));
    pl.Read(argc, argv);
    pl.Status();
    }

Key Classes Declared

  • ParameterList is the key class and is the class you will most often use in your own code
  • IntParameter is a class for retrieving integers
  • SwitchParameter is a class for retrieving on/off switches
  • DoubleParameter is a class for retrieving double precision integers
  • StringParameter is a class for manipulating strings
  • LongParameter is a class for handling long option names

Dependencies

Depends on StringMap.h