CMakeLua/Source/CTest/cmCTestStartCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCTestStartCommand.h,v $
   5   Language:  C++
   6 <<<<<<< cmCTestStartCommand.h
   7   Date:      $Date: 2008/01/23 15:28:01 $
   8   Version:   $Revision: 1.5 $
   9 =======
  10   Date:      $Date: 2008-05-12 13:11:51 $
  11   Version:   $Revision: 1.6 $
  12 >>>>>>> 1.6
  13
  14   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  15   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  16
  17      This software is distributed WITHOUT ANY WARRANTY; without even
  18      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  19      PURPOSE.  See the above copyright notices for more information.
  20
  21 =========================================================================*/
  22 #ifndef cmCTestStartCommand_h
  23 #define cmCTestStartCommand_h
  24
  25 #include "cmCTestCommand.h"
  26
  27 /** \class cmCTestStart
  28  * \brief Run a ctest script
  29  *
  30  * cmCTestStartCommand defineds the command to start the nightly testing.
  31  */
  32 class cmCTestStartCommand : public cmCTestCommand
  33 {
  34 public:
  35
  36   cmCTestStartCommand() {}
  37
  38   /**
  39    * This is a virtual constructor for the command.
  40    */
  41   virtual cmCommand* Clone()
  42     {
  43     cmCTestStartCommand* ni = new cmCTestStartCommand;
  44     ni->CTest = this->CTest;
  45     ni->CTestScriptHandler = this->CTestScriptHandler;
  46     return ni;
  47     }
  48
  49   /**
  50    * This is called when the command is first encountered in
  51    * the CMakeLists.txt file.
  52    */
  53   virtual bool InitialPass(std::vector<std::string> const& args,
  54                            cmExecutionStatus &status);
  55
  56   /**
  57    * The name of the command as specified in CMakeList.txt.
  58    */
  59   virtual const char* GetName() { return "ctest_start";}
  60
  61   /**
  62    * Succinct documentation.
  63    */
  64   virtual const char* GetTerseDocumentation()
  65     {
  66     return "Starts the testing for a given model";
  67     }
  68
  69   /**
  70    * More documentation.
  71    */
  72   virtual const char* GetFullDocumentation()
  73     {
  74     return
  75       "  ctest_start(Model [TRACK <track>] [source [binary]])\n"
  76       "Starts the testing for a given model. The command should be called "
  77       "after the binary directory is initialized. If the 'source' and "
  78       "'binary' directory are not specified, it reads the "
  79       "CTEST_SOURCE_DIRECTORY and CTEST_BINARY_DIRECTORY. If the track is "
  80       "specified, the submissions will go to the specified track.";
  81     }
  82
  83   cmTypeMacro(cmCTestStartCommand, cmCTestCommand);
  84
  85 };
  86
  87
  88 #endif