CMakeLua/Source/CTest/cmCTestStartCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCTestStartCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008/01/23 15:28:01 $
   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 cmCTestStartCommand_h
  18 #define cmCTestStartCommand_h
  19
  20 #include "cmCTestCommand.h"
  21
  22 /** \class cmCTestStart
  23  * \brief Run a ctest script
  24  *
  25  * cmCTestStartCommand defineds the command to start the nightly testing.
  26  */
  27 class cmCTestStartCommand : public cmCTestCommand
  28 {
  29 public:
  30
  31   cmCTestStartCommand() {}
  32
  33   /**
  34    * This is a virtual constructor for the command.
  35    */
  36   virtual cmCommand* Clone()
  37     {
  38     cmCTestStartCommand* ni = new cmCTestStartCommand;
  39     ni->CTest = this->CTest;
  40     ni->CTestScriptHandler = this->CTestScriptHandler;
  41     return ni;
  42     }
  43
  44   /**
  45    * This is called when the command is first encountered in
  46    * the CMakeLists.txt file.
  47    */
  48   virtual bool InitialPass(std::vector<std::string> const& args,
  49                            cmExecutionStatus &status);
  50
  51   /**
  52    * The name of the command as specified in CMakeList.txt.
  53    */
  54   virtual const char* GetName() { return "CTEST_START";}
  55
  56   /**
  57    * Succinct documentation.
  58    */
  59   virtual const char* GetTerseDocumentation()
  60     {
  61     return "Starts the testing for a given model";
  62     }
  63
  64   /**
  65    * More documentation.
  66    */
  67   virtual const char* GetFullDocumentation()
  68     {
  69     return
  70       "  CTEST_START(Model [TRACK <track>] [source [binary]])\n"
  71       "Starts the testing for a given model. The command should be called "
  72       "after the binary directory is initialized. If the 'source' and "
  73       "'binary' directory are not specified, it reads the "
  74       "CTEST_SOURCE_DIRECTORY and CTEST_BINARY_DIRECTORY. If the track is "
  75       "specified, the submissions will go to the specified track.";
  76     }
  77
  78   cmTypeMacro(cmCTestStartCommand, cmCTestCommand);
  79
  80 };
  81
  82
  83 #endif