CMake/Source/CTest/cmCTestSleepCommand.h

78 lines
2.0 KiB
C
Raw Normal View History

/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
2005-01-27 18:11:04 +03:00
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
2005-01-27 18:11:04 +03:00
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
2005-01-27 18:11:04 +03:00
#ifndef cmCTestSleepCommand_h
#define cmCTestSleepCommand_h
#include "cmCTestCommand.h"
/** \class cmCTestSleep
* \brief Run a ctest script
*
* cmLibrarysCommand defines a list of executable (i.e., test)
* programs to create.
*/
class cmCTestSleepCommand : public cmCTestCommand
{
public:
cmCTestSleepCommand() {}
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
cmCTestSleepCommand* ni = new cmCTestSleepCommand;
2006-03-10 23:03:09 +03:00
ni->CTest = this->CTest;
ni->CTestScriptHandler = this->CTestScriptHandler;
2005-01-27 18:11:04 +03:00
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,
cmExecutionStatus &status);
2005-01-27 18:11:04 +03:00
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() const { return "ctest_sleep";}
2005-01-27 18:11:04 +03:00
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation() const
2005-01-27 18:11:04 +03:00
{
return "sleeps for some amount of time";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation() const
2005-01-27 18:11:04 +03:00
{
return
" ctest_sleep(<seconds>)\n"
"Sleep for given number of seconds.\n"
" ctest_sleep(<time1> <duration> <time2>)\n"
"Sleep for t=(time1 + duration - time2) seconds if t > 0.";
2005-01-27 18:11:04 +03:00
}
cmTypeMacro(cmCTestSleepCommand, cmCTestCommand);
};
#endif