newcommandtemplate.h

   1 #ifndef Mothur_newcommandtemplate_h
   2 #define Mothur_newcommandtemplate_h
   3
   4 //
   5 //  newcommandtemplate.h
   6 //  Mothur
   7 //
   8 //  Created by westcott on 5/3/12.
   9 //  Copyright (c) 2012 Schloss Lab. All rights reserved.
  10 //
  11
  12
  13 //*********Be sure to change ifdef and define to a unique name.**************//
  14
  15 /* This class is designed to provide a template for creating new commands.
  16  It includes code snippets to make creating the command classes virtually pure
  17  functions easier. It includes sample parameter declaration and parameter checking,
  18  as well as reference to other classes you may find helpful.
  19  It also includes the code needed to read a sharedfile. It is a work in progress so
  20  please add things you may find helpful to yourself or other developers trying to
  21  add commands to mothur.
  22
  23 */
  24
  25 #include "command.hpp"
  26
  27 /**************************************************************************************************/
  28
  29 class NewCommand : public Command {
  30 public:
  31     NewCommand(string);
  32     NewCommand();
  33     ~NewCommand(){}
  34
  35     vector<string> setParameters();
  36     string getCommandName()                     { return "newCommandNameToBeSeenByUser";                        }
  37     string getCommandCategory()         { return "commandCategory";             }
  38
  39     string getOutputPattern(string);
  40     //commmand category choices: Sequence Processing, OTU-Based Approaches, Hypothesis Testing, Phylotype Analysis, General, Clustering and Hidden
  41         string getHelpString();
  42     string getCitation() { return "http://www.mothur.org/wiki/newCommandNameToBeSeenByUser"; }
  43     string getDescription()             { return "brief description"; }
  44
  45     int execute();
  46     void help() { m->mothurOut(getHelpString()); }
  47
  48 private:
  49     bool abort;
  50     string outputDir;
  51     vector<string> outputNames;
  52 };
  53
  54 /**************************************************************************************************/
  55
  56
  57
  58
  59 #endif