The simplest form of a test unit.
More...
#include <robottestingframework/Test.h>
|
| Test (std::string name, std::string description="") |
| Test constructor.
|
|
virtual | ~Test () |
| Test destructor.
|
|
const std::string | getName () const |
| getName Getting test name.
|
|
const std::string | getDescription () const |
| getDescription Getting test description
|
|
void | setDescription (const std::string description) |
| setDescription Sets an optional string which describes the test.
|
|
virtual void | run (TestResult &result)=0 |
| the main caller of a test.
|
|
virtual void | interrupt () |
| interrupt interrupts the current test run
|
|
virtual bool | succeeded () const =0 |
| succeeded
|
|
|
void | setName (std::string name) |
| setName setting the test name
|
|
The simplest form of a test unit.
Definition at line 34 of file Test.h.
◆ Test()
robottestingframework::Test::Test |
( |
std::string |
name, |
|
|
std::string |
description = "" |
|
) |
| |
|
inline |
Test constructor.
- Parameters
-
name | The test name |
description | An optional string which describes the test |
Definition at line 43 of file Test.h.
◆ ~Test()
virtual robottestingframework::Test::~Test |
( |
| ) |
|
|
inlinevirtual |
◆ getDescription()
const std::string robottestingframework::Test::getDescription |
( |
| ) |
const |
|
inline |
getDescription Getting test description
- Returns
- The description of the test
Definition at line 70 of file Test.h.
◆ getName()
const std::string robottestingframework::Test::getName |
( |
| ) |
const |
|
inline |
getName Getting test name.
- Returns
- The name of the test.
Definition at line 61 of file Test.h.
◆ interrupt()
virtual void robottestingframework::Test::interrupt |
( |
| ) |
|
|
inlinevirtual |
◆ run()
virtual void robottestingframework::Test::run |
( |
TestResult & |
result | ) |
|
|
pure virtual |
◆ setDescription()
void robottestingframework::Test::setDescription |
( |
const std::string |
description | ) |
|
|
inline |
setDescription Sets an optional string which describes the test.
- Parameters
-
description | The description string |
Definition at line 80 of file Test.h.
◆ setName()
void robottestingframework::Test::setName |
( |
std::string |
name | ) |
|
|
inlineprotected |
setName setting the test name
- Parameters
-
Definition at line 111 of file Test.h.
◆ succeeded()
virtual bool robottestingframework::Test::succeeded |
( |
| ) |
const |
|
pure virtual |
◆ strDescription
std::string robottestingframework::Test::strDescription |
|
private |
◆ strName
std::string robottestingframework::Test::strName |
|
private |
The documentation for this class was generated from the following file:
- src/robottestingframework/include/robottestingframework/Test.h