diff options
author | Andy Cedilnik <andy.cedilnik@kitware.com> | 2005-02-17 10:51:52 -0500 |
---|---|---|
committer | Andy Cedilnik <andy.cedilnik@kitware.com> | 2005-02-17 10:51:52 -0500 |
commit | 8fe168651033cb1374b36424ed2458db5d56ab27 (patch) | |
tree | d39ea4af235887acd1f907cb2d1a2948273e6307 /Source/CTest/cmCTestStartCommand.h | |
parent | ad5115d00f4753970187739c20360d922b36e7b1 (diff) | |
download | cmake-8fe168651033cb1374b36424ed2458db5d56ab27.tar.gz |
ENH: Cleanups and add CTEST_START command
Diffstat (limited to 'Source/CTest/cmCTestStartCommand.h')
-rw-r--r-- | Source/CTest/cmCTestStartCommand.h | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/Source/CTest/cmCTestStartCommand.h b/Source/CTest/cmCTestStartCommand.h new file mode 100644 index 0000000000..2bed7d77f9 --- /dev/null +++ b/Source/CTest/cmCTestStartCommand.h @@ -0,0 +1,81 @@ +/*========================================================================= + + Program: CMake - Cross-Platform Makefile Generator + Module: $RCSfile$ + Language: C++ + Date: $Date$ + Version: $Revision$ + + Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved. + See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details. + + This software is distributed WITHOUT ANY WARRANTY; without even + the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR + PURPOSE. See the above copyright notices for more information. + +=========================================================================*/ +#ifndef cmCTestStartCommand_h +#define cmCTestStartCommand_h + +#include "cmCTestCommand.h" + +/** \class cmCTestStart + * \brief Run a ctest script + * + * cmCTestStartCommand defineds the command to start the nightly testing. + */ +class cmCTestStartCommand : public cmCTestCommand +{ +public: + + cmCTestStartCommand() {} + + /** + * This is a virtual constructor for the command. + */ + virtual cmCommand* Clone() + { + cmCTestStartCommand* ni = new cmCTestStartCommand; + ni->m_CTest = this->m_CTest; + ni->m_CTestScriptHandler = this->m_CTestScriptHandler; + return ni; + } + + /** + * This is called when the command is first encountered in + * the CMakeLists.txt file. + */ + virtual bool InitialPass(std::vector<std::string> const& args); + + /** + * The name of the command as specified in CMakeList.txt. + */ + virtual const char* GetName() { return "CTEST_START";} + + /** + * Succinct documentation. + */ + virtual const char* GetTerseDocumentation() + { + return "Starts the testing for a given model"; + } + + /** + * More documentation. + */ + virtual const char* GetFullDocumentation() + { + return + " CTEST_START(Model [source [binary]])\n" + "Starts the testing for a given model. The command should be called after " + "the binary directory is initialized. If the 'source' and 'binary' " + "directory are not specified, it reads the CTEST_SOURCE_DIRECTORY and " + "CTEST_BINARY_DIRECTORY."; + } + + cmTypeMacro(cmCTestStartCommand, cmCTestCommand); + +}; + + +#endif |