Source/CTest/cmCTestSubmitCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCTestSubmitCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2006-03-29 17:01:24 $
   7   Version:   $Revision: 1.5 $
   8
   9   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  10   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  11
  12      This software is distributed WITHOUT ANY WARRANTY; without even
  13      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14      PURPOSE.  See the above copyright notices for more information.
  15
  16 =========================================================================*/
  17 #ifndef cmCTestSubmitCommand_h
  18 #define cmCTestSubmitCommand_h
  19
  20 #include "cmCTestHandlerCommand.h"
  21
  22 /** \class cmCTestSubmit
  23  * \brief Run a ctest script
  24  *
  25  * cmCTestSubmitCommand defineds the command to submit the test results for
  26  * the project.
  27  */
  28 class cmCTestSubmitCommand : public cmCTestHandlerCommand
  29 {
  30 public:
  31
  32   cmCTestSubmitCommand() {}
  33
  34   /**
  35    * This is a virtual constructor for the command.
  36    */
  37   virtual cmCommand* Clone()
  38     {
  39     cmCTestSubmitCommand* ni = new cmCTestSubmitCommand;
  40     ni->CTest = this->CTest;
  41     ni->CTestScriptHandler = this->CTestScriptHandler;
  42     return ni;
  43     }
  44
  45   /**
  46    * The name of the command as specified in CMakeList.txt.
  47    */
  48   virtual const char* GetName() { return "CTEST_SUBMIT";}
  49
  50   /**
  51    * Succinct documentation.
  52    */
  53   virtual const char* GetTerseDocumentation()
  54     {
  55     return "Submits the repository.";
  56     }
  57
  58   /**
  59    * More documentation.
  60    */
  61   virtual const char* GetFullDocumentation()
  62     {
  63     return
  64       "  CTEST_SUBMIT([RETURN_VALUE res])\n"
  65       "Submits the test results for the project.";
  66     }
  67
  68   cmTypeMacro(cmCTestSubmitCommand, cmCTestHandlerCommand);
  69
  70 protected:
  71   cmCTestGenericHandler* InitializeHandler();
  72 };
  73
  74
  75 #endif