tunit::assert Class Reference

The assert class contains a collection of static methods that implement the most common assertions used in tUnit. More...

#include <assert.h>

Inheritance diagram for tunit::assert:

Collaboration diagram for tunit::assert:

Static Public Member Functions
static void	abort ()
	Abort current test. More...
static void	abort (const tunit::line_info &line_info)
	Abort current test. More...
static void	abort (const std::string &message)
	Abort current test. More...
static void	abort (const std::string &message, const tunit::line_info &line_info)
	Abort current test. More...
template<typename TExpected , typename TActual >
static void	are_equal (const TExpected &expected, const TActual &actual)
	Asserts that two type are equal. More...
template<typename TExpected , typename TActual >
static void	are_equal (const TExpected &expected, const TActual &actual, const tunit::line_info &line_info)
	Asserts that two type are equal. More...
template<typename TExpected , typename TActual >
static void	are_equal (const TExpected &expected, const TActual &actual, const std::string &message)
	Asserts that two type are equal. More...
template<typename TExpected , typename TActual >
static void	are_equal (const TExpected &expected, const TActual &actual, const std::string &message, const tunit::line_info &line_info)
	Asserts that two type are equal. More...
static void	are_equal (float expected, float actual, float tolerance)
	Asserts that two type are equal. More...
static void	are_equal (float expected, float actual, float tolerance, const tunit::line_info &line_info)
	Asserts that two type are equal. More...
static void	are_equal (float expected, float &actual, float tolerance, const std::string &message)
	Asserts that two type are equal. More...
static void	are_equal (float expected, float actual, float tolerance, const std::string &message, const tunit::line_info &line_info)
	Asserts that two type are equal. More...
static void	are_equal (double expected, double actual, double tolerance)
	Asserts that two type are equal. More...
static void	are_equal (double expected, double actual, double tolerance, const tunit::line_info &line_info)
	Asserts that two type are equal. More...
static void	are_equal (double expected, double actual, double tolerance, const std::string &message)
	Asserts that two type are equal. More...
static void	are_equal (double expected, double actual, double tolerance, const std::string &message, const tunit::line_info &line_info)
	Asserts that two type are equal. More...
static void	are_equal (long double expected, long double actual, long double tolerance)
	Asserts that two type are equal. More...
static void	are_equal (long double expected, long double actual, long double tolerance, const tunit::line_info &line_info)
	Asserts that two type are equal. More...
static void	are_equal (long double expected, long double actual, long double tolerance, const std::string &message)
	Asserts that two type are equal. More...
static void	are_equal (long double expected, long double actual, long double tolerance, const std::string &message, const tunit::line_info &line_info)
	Asserts that two type are equal. More...
template<typename TExpected , typename TActual >
static void	are_not_equal (const TExpected &expected, const TActual &actual)
	Asserts that two type are not equal. More...
template<typename TExpected , typename TActual >
static void	are_not_equal (const TExpected &expected, const TActual &actual, const tunit::line_info &line_info)
	Asserts that two type are not equal. More...
template<typename TExpected , typename TActual >
static void	are_not_equal (const TExpected &expected, const TActual &actual, const std::string &message)
	Asserts that two type are not equal. More...
template<typename TExpected , typename TActual >
static void	are_not_equal (const TExpected &expected, const TActual &actual, const std::string &message, const tunit::line_info &line_info)
	Asserts that two type are not equal. More...
template<typename TExpected , typename TActual >
static void	are_not_same (const TExpected &expected, const TActual &actual)
	Asserts that two objects do refer to differents objects. More...
template<typename TExpected , typename TActual >
static void	are_not_same (const TExpected &expected, const TActual &actual, const tunit::line_info &line_info)
	Asserts that two objects do refer to differents objects. More...
template<typename TExpected , typename TActual >
static void	are_not_same (const TExpected &expected, const TActual &actual, const std::string &message)
	Asserts that two objects do refer to differents objects. More...
template<typename TExpected , typename TActual >
static void	are_not_same (const TExpected &expected, const TActual &actual, const std::string &message, const tunit::line_info &line_info)
	Asserts that two objects do refer to differents objects. More...
template<typename TExpected , typename TActual >
static void	are_same (const TExpected &expected, const TActual &actual)
	Asserts that two objects do refer to differents objects. More...
template<typename TExpected , typename TActual >
static void	are_same (const TExpected &expected, const TActual &actual, const tunit::line_info &line_info)
	Asserts that two objects do refer to differents objects. More...
template<typename TExpected , typename TActual >
static void	are_same (const TExpected &expected, const TActual &actual, const std::string &message)
	Asserts that two objects do refer to differents objects. More...
template<typename TExpected , typename TActual >
static void	are_same (const TExpected &expected, const TActual &actual, const std::string &message, const tunit::line_info &line_info)
	Asserts that two objects do refer to differents objects. More...
template<typename TItem , typename TCollection >
static void	contains (const TItem &item, const TCollection &collection)
	Asserts that collection contains an item. More...
template<typename TItem , typename TCollection >
static void	contains (const TItem &item, const TCollection &collection, const tunit::line_info &line_info)
	Asserts that collection contains an item. More...
template<typename TItem , typename TCollection >
static void	contains (const TItem &item, const TCollection &collection, const std::string &message)
	Asserts that collection contains an item. More...
template<typename TItem , typename TCollection >
static void	contains (const TItem &item, const TCollection &collection, const std::string &message, const tunit::line_info &line_info)
	Asserts that collection contains an item. More...
static void	does_not_throw (const std::function< void()> &statement)
	Asserts that the staement does not throw an exception. More...
static void	does_not_throw (const std::function< void()> &statement, const tunit::line_info &line_info)
	Asserts that the staement does not throw an exception. More...
static void	does_not_throw (const std::function< void()> &statement, const std::string &message)
	Asserts that the staement does not throw an exception. More...
static void	does_not_throw (const std::function< void()> &statement, const std::string &message, const tunit::line_info &line_info)
	Asserts that the staement does not throw an exception. More...
static void	fail ()
	Throws an tunit::assertion_error exception. More...
static void	fail (const tunit::line_info &line_info)
	Throws an tunit::assertion_error exception. More...
static void	fail (const std::string &message)
	Throws an tunit::assertion_error exception. More...
static void	fail (const std::string &message, const tunit::line_info &line_info)
	Throws an tunit::assertion_error exception. More...
static void	ignore ()
	Ignore current test. More...
static void	ignore (const tunit::line_info &line_info)
	Ignore current test. More...
static void	ignore (const std::string &message)
	Ignore current test. More...
static void	ignore (const std::string &message, const tunit::line_info &line_info)
	Ignore current test. More...
template<typename TValue >
static void	is_empty (const TValue &value)
	Asserts that collection contains an item. More...
template<typename TValue >
static void	is_empty (const TValue &value, const tunit::line_info &line_info)
	Asserts that collection contains an item. More...
template<typename TValue >
static void	is_empty (const TValue &value, const std::string &message)
	Asserts that collection contains an item. More...
template<typename TValue >
static void	is_empty (const TValue &value, const std::string &message, const tunit::line_info &line_info)
	Asserts that collection contains an item. More...
static void	is_false (bool condition)
	Asserts that ta condition is false. More...
static void	is_false (bool condition, const tunit::line_info &line_info)
	Asserts that a condition is false. More...
static void	is_false (bool condition, const std::string &message)
	Asserts that a condition is false. More...
static void	is_false (bool condition, const std::string &message, const tunit::line_info &line_info)
	Asserts that a condition is false. More...
template<typename TValue1 , typename TValue2 >
static void	is_greater (const TValue1 &val1, const TValue2 &val2)
	Asserts that the first value is greater than the second value. More...
template<typename TValue1 , typename TValue2 >
static void	is_greater (const TValue1 &val1, const TValue2 &val2, const tunit::line_info &line_info)
	Asserts that the first value is greater than the second value. More...
template<typename TValue1 , typename TValue2 >
static void	is_greater (const TValue1 &val1, const TValue2 &val2, const std::string &message)
	Asserts that the first value is greater than the second value. More...
template<typename TValue1 , typename TValue2 >
static void	is_greater (const TValue1 &val1, const TValue2 &val2, const std::string &message, const tunit::line_info &line_info)
	Asserts that the first value is greater than the second value. More...
template<typename TValue1 , typename TValue2 >
static void	is_greater_or_equal (const TValue1 &val1, const TValue2 &val2)
	Asserts that the first value is greater than or equal to the second value. More...
template<typename TValue1 , typename TValue2 >
static void	is_greater_or_equal (const TValue1 &val1, const TValue2 &val2, const tunit::line_info &line_info)
	Asserts that the first value is greater than or equal to the second value. More...
template<typename TValue1 , typename TValue2 >
static void	is_greater_or_equal (const TValue1 &val1, const TValue2 &val2, const std::string &message)
	Asserts that the first value is greater than or equal to the second value. More...
template<typename TValue1 , typename TValue2 >
static void	is_greater_or_equal (const TValue1 &val1, const TValue2 &val2, const std::string &message, const tunit::line_info &line_info)
	Asserts that the first value is greater than or equal to the second value. More...
template<typename Type , typename TValue >
static void	is_instance_of (const TValue &value)
	Asserts that an object is of the type supplied or a derived type. More...
template<typename Type , typename TValue >
static void	is_instance_of (const TValue &value, const tunit::line_info &line_info)
	Asserts that an object is of the type supplied or a derived type. More...
template<typename Type , typename TValue >
static void	is_instance_of (const TValue &value, const std::string &message)
	Asserts that an object is of the type supplied or a derived type. More...
template<typename Type , typename TValue >
static void	is_instance_of (const TValue &value, const std::string &message, const tunit::line_info &line_info)
	Asserts that an object is of the type supplied or a derived type. More...
template<typename TValue1 , typename TValue2 >
static void	is_less (const TValue1 &val1, const TValue2 &val2)
	Asserts that the first value is is_less than the second value. More...
template<typename TValue1 , typename TValue2 >
static void	is_less (const TValue1 &val1, const TValue2 &val2, const tunit::line_info &line_info)
	Asserts that the first value is is_less than the second value. More...
template<typename TValue1 , typename TValue2 >
static void	is_less (const TValue1 &val1, const TValue2 &val2, const std::string &message)
	Asserts that the first value is is_less than the second value. More...
template<typename TValue1 , typename TValue2 >
static void	is_less (const TValue1 &val1, const TValue2 &val2, const std::string &message, const tunit::line_info &line_info)
	Asserts that the first value is is_less than the second value. More...
template<typename TValue1 , typename TValue2 >
static void	is_less_or_equal (const TValue1 &val1, const TValue2 &val2)
	Asserts that the first value is is_less than or equal to the second value. More...
template<typename TValue1 , typename TValue2 >
static void	is_less_or_equal (const TValue1 &val1, const TValue2 &val2, const tunit::line_info &line_info)
	Asserts that the first value is is_less than or equal to the second value. More...
template<typename TValue1 , typename TValue2 >
static void	is_less_or_equal (const TValue1 &val1, const TValue2 &val2, const std::string &message)
	Asserts that the first value is is_less than or equal to the second value. More...
template<typename TValue1 , typename TValue2 >
static void	is_less_or_equal (const TValue1 &val1, const TValue2 &val2, const std::string &message, const tunit::line_info &line_info)
	Asserts that the first value is is_less than or equal to the second value. More...
static void	is_NaN (double value)
	that a value is NaN. More...
static void	is_NaN (double value, const tunit::line_info &line_info)
	that a value is NaN. More...
static void	is_NaN (double value, const std::string &message)
	Asserts that a value is NaN. More...
static void	is_NaN (double value, const std::string &message, const tunit::line_info &line_info)
	Asserts that a value is NaN. More...
static void	is_NaN (long double value)
	that a value is NaN. More...
static void	is_NaN (long double value, const tunit::line_info &line_info)
	that a value is NaN. More...
static void	is_NaN (long double value, const std::string &message)
	Asserts that a value is NaN. More...
static void	is_NaN (long double value, const std::string &message, const tunit::line_info &line_info)
	Asserts that a value is NaN. More...
static void	is_NaN (float value)
	that a value is NaN. More...
static void	is_NaN (float value, const tunit::line_info &line_info)
	that a value is NaN. More...
static void	is_NaN (float value, const std::string &message)
	Asserts that a value is NaN. More...
static void	is_NaN (float value, const std::string &message, const tunit::line_info &line_info)
	Asserts that a value is NaN. More...
template<typename TValue >
static void	is_negative (const TValue &value)
	Asserts that ta condition is negative. More...
template<typename TValue >
static void	is_negative (const TValue &value, const tunit::line_info &line_info)
	Asserts that ta condition is negative. More...
template<typename TValue >
static void	is_negative (const TValue &value, const std::string &message)
	Asserts that ta condition is negative. More...
template<typename TValue >
static void	is_negative (const TValue &value, const std::string &message, const tunit::line_info &line_info)
	Asserts that ta condition is negative. More...
template<typename TValue >
static void	is_not_empty (const TValue &value)
	Asserts that collection oes not contain any item. More...
template<typename TValue >
static void	is_not_empty (const TValue &value, const tunit::line_info &line_info)
	Asserts that collection does not contain any item. More...
template<typename TValue >
static void	is_not_empty (const TValue &value, const std::string &message)
	Asserts that collection does not contain any item. More...
template<typename TValue >
static void	is_not_empty (const TValue &value, const std::string &message, const tunit::line_info &line_info)
	Asserts that collection does not contain any item. More...
template<typename Type , typename TValue >
static void	is_not_instance_of (const TValue &value)
	Asserts that an object is not of the type supplied or a derived type. More...
template<typename Type , typename TValue >
static void	is_not_instance_of (const TValue &value, const tunit::line_info &line_info)
	Asserts that an object is not of the type supplied or a derived type. More...
template<typename Type , typename TValue >
static void	is_not_instance_of (const TValue &value, const std::string &message)
	Asserts that an object is not of the type supplied or a derived type. More...
template<typename Type , typename TValue >
static void	is_not_instance_of (const TValue &value, const std::string &message, const tunit::line_info &line_info)
	Asserts that an object is not of the type supplied or a derived type. More...
template<typename TPointer >
static void	is_not_null (const TPointer *pointer)
	Asserts that the pointer is not null. More...
template<typename TPointer >
static void	is_not_null (const TPointer *pointer, const tunit::line_info &line_info)
	Asserts that the pointer is not null. More...
template<typename TPointer >
static void	is_not_null (const TPointer *pointer, const std::string &message)
	Asserts that the pointer is not null. More...
template<typename TPointer >
static void	is_not_null (const TPointer *pointer, const std::string &message, const tunit::line_info &line_info)
	Asserts that the pointer is not null. More...
template<typename TPointer >
static void	is_not_null (const std::unique_ptr< TPointer > &pointer)
	Asserts that the pointer is not null. More...
template<typename TPointer >
static void	is_not_null (const std::unique_ptr< TPointer > &pointer, const tunit::line_info &line_info)
	Asserts that the pointer is not null. More...
template<typename TPointer >
static void	is_not_null (const std::unique_ptr< TPointer > &pointer, const std::string &message)
	Asserts that the pointer is not null. More...
template<typename TPointer >
static void	is_not_null (const std::unique_ptr< TPointer > &pointer, const std::string &message, const tunit::line_info &line_info)
	Asserts that the pointer is not null. More...
template<typename TPointer >
static void	is_not_null (const std::shared_ptr< TPointer > &pointer)
	Asserts that the pointer is not null. More...
template<typename TPointer >
static void	is_not_null (const std::shared_ptr< TPointer > &pointer, const tunit::line_info &line_info)
	Asserts that the pointer is not null. More...
template<typename TPointer >
static void	is_not_null (const std::shared_ptr< TPointer > &pointer, const std::string &message)
	Asserts that the pointer is not null. More...
template<typename TPointer >
static void	is_not_null (const std::shared_ptr< TPointer > &pointer, const std::string &message, const tunit::line_info &line_info)
	Asserts that the pointer is not null. More...
template<typename TPointer >
static void	is_not_null (const std::weak_ptr< TPointer > &pointer)
	Asserts that the pointer is not null. More...
template<typename TPointer >
static void	is_not_null (const std::weak_ptr< TPointer > &pointer, const tunit::line_info &line_info)
	Asserts that the pointer is not null. More...
template<typename TPointer >
static void	is_not_null (const std::weak_ptr< TPointer > &pointer, const std::string &message)
	Asserts that the pointer is not null. More...
template<typename TPointer >
static void	is_not_null (const std::weak_ptr< TPointer > &pointer, const std::string &message, const tunit::line_info &line_info)
	Asserts that the pointer is not null. More...
static void	is_not_null (std::nullptr_t pointer)
	Asserts that the pointer is not null. More...
static void	is_not_null (std::nullptr_t pointer, const tunit::line_info &line_info)
	Asserts that the pointer is not null. More...
static void	is_not_null (std::nullptr_t pointer, const std::string &message)
	Asserts that the pointer is not null. More...
static void	is_not_null (std::nullptr_t pointer, const std::string &message, const tunit::line_info &line_info)
	Asserts that the pointer is not null. More...
template<typename TValue >
static void	is_not_zero (const TValue &value)
	Asserts that ta condition is not zero. More...
template<typename TValue >
static void	is_not_zero (const TValue &value, const tunit::line_info &line_info)
	Asserts that ta condition is not zero. More...
template<typename TValue >
static void	is_not_zero (const TValue &value, const std::string &message)
	Asserts that ta condition is not zero. More...
template<typename TValue >
static void	is_not_zero (const TValue &value, const std::string &message, const tunit::line_info &line_info)
	Asserts that ta condition is not zero. More...
template<typename TPointer >
static void	is_null (const TPointer *pointer)
	Asserts that the pointer is null. More...
template<typename TPointer >
static void	is_null (const TPointer *pointer, const tunit::line_info &line_info)
	Asserts that the pointer is null. More...
template<typename TPointer >
static void	is_null (const TPointer *pointer, const std::string &message)
	Asserts that the pointer is null. More...
template<typename TPointer >
static void	is_null (const TPointer *pointer, const std::string &message, const tunit::line_info &line_info)
	Asserts that the pointer is null. More...
template<typename TPointer >
static void	is_null (const std::unique_ptr< TPointer > &pointer)
	Asserts that the pointer is null. More...
template<typename TPointer >
static void	is_null (const std::unique_ptr< TPointer > &pointer, const tunit::line_info &line_info)
	Asserts that the pointer is null. More...
template<typename TPointer >
static void	is_null (const std::unique_ptr< TPointer > &pointer, const std::string &message)
	Asserts that the pointer is null. More...
template<typename TPointer >
static void	is_null (const std::unique_ptr< TPointer > &pointer, const std::string &message, const tunit::line_info &line_info)
	Asserts that the pointer is null. More...
template<typename TPointer >
static void	is_null (const std::shared_ptr< TPointer > &pointer)
	Asserts that the pointer is null. More...
template<typename TPointer >
static void	is_null (const std::shared_ptr< TPointer > &pointer, const tunit::line_info &line_info)
	Asserts that the pointer is null. More...
template<typename TPointer >
static void	is_null (const std::shared_ptr< TPointer > &pointer, const std::string &message)
	Asserts that the pointer is null. More...
template<typename TPointer >
static void	is_null (const std::shared_ptr< TPointer > &pointer, const std::string &message, const tunit::line_info &line_info)
	Asserts that the pointer is null. More...
template<typename TPointer >
static void	is_null (const std::weak_ptr< TPointer > &pointer)
	Asserts that the pointer is null. More...
template<typename TPointer >
static void	is_null (const std::weak_ptr< TPointer > &pointer, const tunit::line_info &line_info)
	Asserts that the pointer is null. More...
template<typename TPointer >
static void	is_null (const std::weak_ptr< TPointer > &pointer, const std::string &message)
	Asserts that the pointer is null. More...
template<typename TPointer >
static void	is_null (const std::weak_ptr< TPointer > &pointer, const std::string &message, const tunit::line_info &line_info)
	Asserts that the pointer is null. More...
static void	is_null (std::nullptr_t pointer)
	Asserts that the pointer is null. More...
static void	is_null (std::nullptr_t pointer, const tunit::line_info &line_info)
	Asserts that the pointer is null. More...
static void	is_null (std::nullptr_t pointer, const std::string &message)
	Asserts that the pointer is null. More...
static void	is_null (std::nullptr_t pointer, const std::string &message, const tunit::line_info &line_info)
	Asserts that the pointer is null. More...
template<typename TValue >
static void	is_positive (const TValue &value)
	Asserts that ta condition is positive. More...
template<typename TValue >
static void	is_positive (const TValue &value, const tunit::line_info &line_info)
	Asserts that ta condition is positive. More...
template<typename TValue >
static void	is_positive (const TValue &value, const std::string &message)
	Asserts that ta condition is positive. More...
template<typename TValue >
static void	is_positive (const TValue &value, const std::string &message, const tunit::line_info &line_info)
	Asserts that ta condition is positive. More...
static void	is_true (bool condition)
	Asserts that ta condition is true. More...
static void	is_true (bool condition, const tunit::line_info &line_info)
	Asserts that a condition is true. More...
static void	is_true (bool condition, const std::string &message)
	Asserts that a condition is true. More...
static void	is_true (bool condition, const std::string &message, const tunit::line_info &line_info)
	Asserts that a condition is true. More...
template<typename TValue >
static void	is_zero (const TValue &value)
	Asserts that ta condition is zero. More...
template<typename TValue >
static void	is_zero (const TValue &value, const tunit::line_info &line_info)
	Asserts that ta condition is zero. More...
template<typename TValue >
static void	is_zero (const TValue &value, const std::string &message)
	Asserts that ta condition is zero. More...
template<typename TValue >
static void	is_zero (const TValue &value, const std::string &message, const tunit::line_info &line_info)
	Asserts that ta condition is zero. More...
static void	succeed ()
	Generates a success with a generic message. More...
static void	succeed (const tunit::line_info &line_info)
	Generates a success with a generic message. More...
static void	succeed (const std::string &message)
	Generates a success with a generic message. More...
static void	succeed (const std::string &message, const tunit::line_info &line_info)
	Generates a success with a generic message. More...
template<typename TException >
static void	throws (const std::function< void()> &statement)
	Asserts that the statement throws a particular exception when called. More...
template<typename TException >
static void	throws (const std::function< void()> &statement, const tunit::line_info &line_info)
	Asserts that the statement throws a particular exception when called. More...
template<typename TException >
static void	throws (const std::function< void()> &statement, const std::string &message)
	Asserts that the statement throws a particular exception when called. More...
template<typename TException >
static void	throws (const std::function< void()> &statement, const std::string &message, const tunit::line_info &line_info)
	Asserts that the statement throws a particular exception when called. More...
static void	throws_any (const std::function< void()> &statement)
	Asserts that the staement does not throw an exception. More...
static void	throws_any (const std::function< void()> &statement, const tunit::line_info &line_info)
	Asserts that the staement does not throw an exception. More...
static void	throws_any (const std::function< void()> &statement, const std::string &message)
	Asserts that the staement does not throw an exception. More...
static void	throws_any (const std::function< void()> &statement, const std::string &message, const tunit::line_info &line_info)
	Asserts that the staement does not throw an exception. More...

Static Protected Member Functions
static void	error ()
static void	error (const std::string &actual, const std::string &expected, const std::string &message, const tunit::line_info &line_info)
static void	fail (const std::string &actual, const std::string &expected, const std::string &message, const tunit::line_info &line_info)
template<typename TCollection >
static std::string	join_items (const TCollection &collection)
static std::string	join_items (const std::string &str)
template<typename TValue >
static std::string	to_string (const TValue &value)
template<typename TValue >
static std::string	to_string (const TValue *value)

Detailed Description

The assert class contains a collection of static methods that implement the most common assertions used in tUnit.

Examples

This example show how to used some methods :

Member Function Documentation

abort() [1/4]

static void tunit::base_assert::abort ( )

inlinestaticinherited

Abort current test.

This is used by the other Assert functions.

Examples

tunit::assert::abort("User message...", line_info_); // test throws an abort_error exception.

abort() [2/4]

static void tunit::base_assert::abort ( const tunit::line_info &  line_info )

inlinestaticinherited

Abort current test.

This is used by the other Assert functions.

Parameters

line_info

Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::abort("User message...", line_info_); // test throws an abort_error exception.

abort() [3/4]

static void tunit::base_assert::abort ( const std::string &  message )

inlinestaticinherited

Abort current test.

This is used by the other Assert functions.

Parameters

message

A user message to display if the assertion fails. This message can be seen in the unit test results.

Examples

tunit::assert::abort("User message...", line_info_); // test throws an abort_error exception.

abort() [4/4]

static void tunit::base_assert::abort ( const std::string &  message, const tunit::line_info &  line_info  )

staticinherited

Abort current test.

This is used by the other Assert functions.

Parameters

message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples

tunit::assert::abort("User message...", line_info_); // test throws an abort_error exception.

are_equal() [1/16]

template<typename TExpected , typename TActual >

static void tunit::assert::are_equal ( const TExpected &  expected, const TActual &  actual  )

inlinestatic

Asserts that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::are_equal(24, int(24)); // test ok.
tunit::assert::are_equal(23, int(24)); // test throws an assertion_error exception.

are_equal() [2/16]

template<typename TExpected , typename TActual >

static void tunit::assert::are_equal ( const TExpected &  expected, const TActual &  actual, const tunit::line_info &  line_info  )

inlinestatic

Asserts that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::are_equal(24, int(24), line_info_); // test ok.
tunit::assert::are_equal(23, int(24), line_info_); // test throws an assertion_error exception.

are_equal() [3/16]

template<typename TExpected , typename TActual >

static void tunit::assert::are_equal ( const TExpected &  expected, const TActual &  actual, const std::string &  message  )

inlinestatic

Asserts that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::are_equal(24, int(24), "User message..."); // test ok.
tunit::assert::are_equal(23, int(24), "User message..."); // test throws an assertion_error exception.

are_equal() [4/16]

template<typename TExpected , typename TActual >

static void tunit::assert::are_equal ( const TExpected &  expected, const TActual &  actual, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::are_equal(24, int(24), "User message...", line_info_); // test ok.
tunit::assert::are_equal(23, int(24), "User message...", line_info_); // test throws an assertion_error exception.

are_equal() [5/16]

static void tunit::assert::are_equal ( float  expected, float  actual, float  tolerance  )

inlinestatic

Asserts that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
tolelerance	Indicates a tolerance within which they will be considered as equal.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

float f = 0.00007999999999f;
tunit::assert::are_equal_(0.00008f, f, 0.0000000000001f); // test ok.
tunit::assert::are_equal_(0.00008f, f, 0.00000000000001f); // test throws an assertion_error exception.

are_equal() [6/16]

static void tunit::assert::are_equal ( float  expected, float  actual, float  tolerance, const tunit::line_info &  line_info  )

inlinestatic

Asserts that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
tolelerance	Indicates a tolerance within which they will be considered as equal.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

float f = 0.00007999999999f;
tunit::assert::are_equal_(0.00008f, f, 0.0000000000001f, line_info_); // test ok.
tunit::assert::are_equal_(0.00008f, f, 0.00000000000001f, line_info_); // test throws an assertion_error exception.

are_equal() [7/16]

static void tunit::assert::are_equal ( float  expected, float &  actual, float  tolerance, const std::string &  message  )

inlinestatic

Asserts that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
tolelerance	Indicates a tolerance within which they will be considered as equal.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

float f = 0.00007999999999f;
tunit::assert::are_equal_(0.00008f, f, 0.0000000000001f, "User message..."); // test ok.
tunit::assert::are_equal_(0.00008f, f, 0.00000000000001f, "User message..."); // test throws an assertion_error exception.

are_equal() [8/16]

static void tunit::assert::are_equal ( float  expected, float  actual, float  tolerance, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
tolelerance	Indicates a tolerance within which they will be considered as equal.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

float f = 0.00007999999999f;
tunit::assert::are_equal_(0.00008f, f, 0.0000000000001f, "User message...", line_info_); // test ok.
tunit::assert::are_equal_(0.00008f, f, 0.00000000000001f, "User message...", line_info_); // test throws an assertion_error exception.

are_equal() [9/16]

static void tunit::assert::are_equal ( double  expected, double  actual, double  tolerance  )

inlinestatic

Asserts that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
tolelerance	Indicates a tolerance within which they will be considered as equal.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

double d = 0.00007999999999;
tunit::assert::are_equal_(0.00008, d, 0.0000000000001); // test ok.
tunit::assert::are_equal_(0.00008, d, 0.00000000000001); // test throws an assertion_error exception.

are_equal() [10/16]

static void tunit::assert::are_equal ( double  expected, double  actual, double  tolerance, const tunit::line_info &  line_info  )

inlinestatic

Asserts that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
tolelerance	Indicates a tolerance within which they will be considered as equal.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

double d = 0.00007999999999;
tunit::assert::are_equal_(0.00008, d, 0.0000000000001, line_info_); // test ok.
tunit::assert::are_equal_(0.00008, d, 0.00000000000001, line_info_); // test throws an assertion_error exception.

are_equal() [11/16]

static void tunit::assert::are_equal ( double  expected, double  actual, double  tolerance, const std::string &  message  )

inlinestatic

Asserts that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
tolelerance	Indicates a tolerance within which they will be considered as equal.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

double d = 0.00007999999999;
tunit::assert::are_equal_(0.00008, d, 0.0000000000001, "User message..."); // test ok.
tunit::assert::are_equal_(0.00008, d, 0.00000000000001, "User message..."); // test throws an assertion_error exception.

are_equal() [12/16]

static void tunit::assert::are_equal ( double  expected, double  actual, double  tolerance, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
tolelerance	Indicates a tolerance within which they will be considered as equal.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

double d = 0.00007999999999;
tunit::assert::are_equal_(0.00008, d, 0.0000000000001, "User message...", line_info_); // test ok.
tunit::assert::are_equal_(0.00008, d, 0.00000000000001, "User message...", line_info_); // test throws an assertion_error exception.

are_equal() [13/16]

static void tunit::assert::are_equal ( long double  expected, long double  actual, long double  tolerance  )

inlinestatic

Asserts that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
tolelerance	Indicates a tolerance within which they will be considered as equal.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

long double ld = 0.00007999999999;
tunit::assert::are_equal_(0.00008l, ld, 0.0000000000001l); // test ok.
tunit::assert::are_equal_(0.00008l, ld, 0.00000000000001l); // test throws an assertion_error exception.

are_equal() [14/16]

static void tunit::assert::are_equal ( long double  expected, long double  actual, long double  tolerance, const tunit::line_info &  line_info  )

inlinestatic

Asserts that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
tolelerance	Indicates a tolerance within which they will be considered as equal.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

long double ld = 0.00007999999999;
tunit::assert::are_equal_(0.00008l, ld, 0.0000000000001l, line_info_); // test ok.
tunit::assert::are_equal_(0.00008l, ld, 0.00000000000001l, line_info_); // test throws an assertion_error exception.

are_equal() [15/16]

static void tunit::assert::are_equal ( long double  expected, long double  actual, long double  tolerance, const std::string &  message  )

inlinestatic

Asserts that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
tolelerance	Indicates a tolerance within which they will be considered as equal.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

long double ld = 0.00007999999999;
tunit::assert::are_equal_(0.00008l, ld, 0.0000000000001l, "User message..."); // test ok.
tunit::assert::are_equal_(0.00008l, ld, 0.00000000000001l, "User message..."); // test throws an assertion_error exception.

are_equal() [16/16]

static void tunit::assert::are_equal ( long double  expected, long double  actual, long double  tolerance, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
tolelerance	Indicates a tolerance within which they will be considered as equal.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

long double ld = 0.00007999999999;
tunit::assert::are_equal_(0.00008l, ld, 0.0000000000001l, "User message...", line_info_); // test ok.
tunit::assert::are_equal_(0.00008l, ld, 0.00000000000001l, "User message...", line_info_); // test throws an assertion_error exception.

are_not_equal() [1/4]

template<typename TExpected , typename TActual >

static void tunit::assert::are_not_equal ( const TExpected &  expected, const TActual &  actual  )

inlinestatic

Asserts that two type are not equal.

Parameters

expected	the expected value.
actual	the actual value.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::are_not_equal(23, int(24)); // test ok.
tunit::assert::are_not_equal(24, int(24)); // test throws an assertion_error exception.

are_not_equal() [2/4]

template<typename TExpected , typename TActual >

static void tunit::assert::are_not_equal ( const TExpected &  expected, const TActual &  actual, const tunit::line_info &  line_info  )

inlinestatic

Asserts that two type are not equal.

Parameters

expected	the expected value.
actual	the actual value.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::are_not_equal(23, int(24), line_info_); // test ok.
tunit::assert::are_not_equal(24, int(24), line_info_); // test throws an assertion_error exception.

are_not_equal() [3/4]

template<typename TExpected , typename TActual >

static void tunit::assert::are_not_equal ( const TExpected &  expected, const TActual &  actual, const std::string &  message  )

inlinestatic

Asserts that two type are not equal.

Parameters

expected	the expected value.
actual	the actual value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::are_not_equal(23, int(24), "User message..."); // test ok.
tunit::assert::are_not_equal(24, int(24), "User message..."); // test throws an assertion_error exception.

are_not_equal() [4/4]

template<typename TExpected , typename TActual >

static void tunit::assert::are_not_equal ( const TExpected &  expected, const TActual &  actual, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that two type are not equal.

Parameters

expected	the expected value.
actual	the actual value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::are_not_equal(23, int(24), "User message...", line_info_); // test ok.
tunit::assert::are_not_equal(24, int(24), "User message...", line_info_); // test throws an assertion_error exception.

are_not_same() [1/4]

template<typename TExpected , typename TActual >

static void tunit::assert::are_not_same ( const TExpected &  expected, const TActual &  actual  )

inlinestatic

Asserts that two objects do refer to differents objects.

Parameters

expected	the expected value.
actual	the actual value.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int a = 24;
int& b = a;
int c=  24;
tunit::assert::are_not_same(c, a); // test ok.
tunit::assert::are_not_same(b, a); // test throws an assertion_error exception.

are_not_same() [2/4]

template<typename TExpected , typename TActual >

static void tunit::assert::are_not_same ( const TExpected &  expected, const TActual &  actual, const tunit::line_info &  line_info  )

inlinestatic

Asserts that two objects do refer to differents objects.

Parameters

expected	the expected value.
actual	the actual value.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int a = 24;
int& b = a;
int c=  24;
tunit::assert::are_not_same(c, a, line_info_); // test ok.
tunit::assert::are_not_same(b, a, line_info); // test throws an assertion_error exception.

are_not_same() [3/4]

template<typename TExpected , typename TActual >

static void tunit::assert::are_not_same ( const TExpected &  expected, const TActual &  actual, const std::string &  message  )

inlinestatic

Asserts that two objects do refer to differents objects.

Parameters

expected	the expected value.
actual	the actual value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int a = 24;
int& b = a;
int c=  24;
tunit::assert::are_not_same(c, a, "User message..."); // test ok.
tunit::assert::are_not_same(b, a, "User message..."); // test throws an assertion_error exception.

are_not_same() [4/4]

template<typename TExpected , typename TActual >

static void tunit::assert::are_not_same ( const TExpected &  expected, const TActual &  actual, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that two objects do refer to differents objects.

Parameters

expected	the expected value.
actual	the actual value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int a = 24;
int& b = a;
int c=  24;
tunit::assert::are_not_same(c, a, "User message...", line_info_); // test ok.
tunit::assert::are_not_same(b, a, "User message...", line_info); // test throws an assertion_error exception.

are_same() [1/4]

template<typename TExpected , typename TActual >

static void tunit::assert::are_same ( const TExpected &  expected, const TActual &  actual  )

inlinestatic

Asserts that two objects do refer to differents objects.

Parameters

expected	the expected value.
actual	the actual value.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int a = 24;
int& b = a;
int c=  24;
tunit::assert::are_same(b, a); // test ok.
tunit::assert::are_same(c, a); // test throws an assertion_error exception.

are_same() [2/4]

template<typename TExpected , typename TActual >

static void tunit::assert::are_same ( const TExpected &  expected, const TActual &  actual, const tunit::line_info &  line_info  )

inlinestatic

Asserts that two objects do refer to differents objects.

Parameters

expected	the expected value.
actual	the actual value.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int a = 24;
int& b = a;
int c=  24;
tunit::assert::are_same(b, a, line_info_); // test ok.
tunit::assert::are_same(c, a, line_info_); // test throws an assertion_error exception.

are_same() [3/4]

template<typename TExpected , typename TActual >

static void tunit::assert::are_same ( const TExpected &  expected, const TActual &  actual, const std::string &  message  )

inlinestatic

Asserts that two objects do refer to differents objects.

Parameters

expected	the expected value.
actual	the actual value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int a = 24;
int& b = a;
int c=  24;
tunit::assert::are_same(b, a, "User message..."); // test ok.
tunit::assert::are_same(c, a, "User message..."); // test throws an assertion_error exception.

are_same() [4/4]

template<typename TExpected , typename TActual >

static void tunit::assert::are_same ( const TExpected &  expected, const TActual &  actual, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that two objects do refer to differents objects.

Parameters

expected	the expected value.
actual	the actual value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int a = 24;
int& b = a;
int c=  24;
tunit::assert::are_same(b, a, "User message...", line_info_); // test ok.
tunit::assert::are_same(c, a, "User message...", line_info_); // test throws an assertion_error exception.

contains() [1/4]

template<typename TItem , typename TCollection >

static void tunit::assert::contains ( const TItem &  item, const TCollection &  collection  )

inlinestatic

Asserts that collection contains an item.

Parameters

item	object to verify.
collection	that contains object.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {0, 1, 2, 3};
tunit::assert::contains(2, v1); // test ok.
tunit::assert::contains(4, v1); // test throws an assertion_error exception.

contains() [2/4]

template<typename TItem , typename TCollection >

static void tunit::assert::contains ( const TItem &  item, const TCollection &  collection, const tunit::line_info &  line_info  )

inlinestatic

Asserts that collection contains an item.

Parameters

item	object to verify.
collection	that contains object.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {0, 1, 2, 3};
tunit::assert::contains(2, v1, line_info_); // test ok.
tunit::assert::contains(4, v1, line_info_); // test throws an assertion_error exception.

contains() [3/4]

template<typename TItem , typename TCollection >

static void tunit::assert::contains ( const TItem &  item, const TCollection &  collection, const std::string &  message  )

inlinestatic

Asserts that collection contains an item.

Parameters

item	object to verify.
collection	that contains object.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {0, 1, 2, 3};
tunit::assert::contains(2, v1, "User message..."); // test ok.
tunit::assert::contains(4, v1, "User message..."); // test throws an assertion_error exception.

contains() [4/4]

template<typename TItem , typename TCollection >

static void tunit::assert::contains ( const TItem &  item, const TCollection &  collection, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that collection contains an item.

Parameters

item	object to verify.
collection	that contains object.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {0, 1, 2, 3};
tunit::assert::contains(2, v1, "User message...", line_info_); // test ok.
tunit::assert::contains(4, v1, "User message...", line_info_); // test throws an assertion_error exception.

does_not_throw() [1/4]

static void tunit::assert::does_not_throw ( const std::function< void()> &  statement )

inlinestatic

Asserts that the staement does not throw an exception.

Parameters

statement

The statement that verify.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {1, 2, 3, 4};
tunit::assert::does_not_throw([&] {v1.at(2);}); // test ok.
tunit::assert::does_not_throw([&] {v1.at(5);}); // test throws an assertion_error exception.

does_not_throw() [2/4]

static void tunit::assert::does_not_throw ( const std::function< void()> &  statement, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the staement does not throw an exception.

Parameters

statement	The statement that verify.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {1, 2, 3, 4};
tunit::assert::does_not_throw([&] {v1.at(2);}, line_info_); // test ok.
tunit::assert::does_not_throw([&] {v1.at(5);}, line_info_); // test throws an assertion_error exception.

does_not_throw() [3/4]

static void tunit::assert::does_not_throw ( const std::function< void()> &  statement, const std::string &  message  )

inlinestatic

Asserts that the staement does not throw an exception.

Parameters

statement	The statement that verify.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {1, 2, 3, 4};
tunit::assert::does_not_throw([&] {v1.at(2);}, "User message..."); // test ok.
tunit::assert::does_not_throw([&] {v1.at(5);}, "User message..."); // test throws an assertion_error exception.

does_not_throw() [4/4]

static void tunit::assert::does_not_throw ( const std::function< void()> &  statement, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the staement does not throw an exception.

Parameters

statement	The statement that verify.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {1, 2, 3, 4};
tunit::assert::does_not_throw([&] {v1.at(2);}, "User message...", line_info_); // test ok.
tunit::assert::does_not_throw([&] {v1.at(5);}, "User message...", line_info_); // test throws an assertion_error exception.

fail() [1/4]

static void tunit::base_assert::fail ( )

inlinestaticinherited

Throws an tunit::assertion_error exception.

This is used by the other Assert functions.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::fail("User message...", line_info_); // test throws an assertion_error exception.

fail() [2/4]

static void tunit::base_assert::fail ( const tunit::line_info &  line_info )

inlinestaticinherited

Throws an tunit::assertion_error exception.

This is used by the other Assert functions.

Parameters

line_info

Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::fail("User message...", line_info_); // test throws an assertion_error exception.

fail() [3/4]

static void tunit::base_assert::fail ( const std::string &  message )

inlinestaticinherited

Throws an tunit::assertion_error exception.

This is used by the other Assert functions.

Parameters

message

A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::fail("User message...", line_info_); // test throws an assertion_error exception.

fail() [4/4]

static void tunit::base_assert::fail ( const std::string &  message, const tunit::line_info &  line_info  )

inlinestaticinherited

Throws an tunit::assertion_error exception.

This is used by the other Assert functions.

Parameters

message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::fail("User message...", line_info_); // test throws an assertion_error exception.

ignore() [1/4]

static void tunit::base_assert::ignore ( )

inlinestaticinherited

Ignore current test.

This is used by the other Assert functions.

Examples

tunit::assert::ignore("User message...", line_info_); // test throws an ignore_error exception.

ignore() [2/4]

static void tunit::base_assert::ignore ( const tunit::line_info &  line_info )

inlinestaticinherited

Ignore current test.

This is used by the other Assert functions.

Parameters

line_info

Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::ignore("User message...", line_info_); // test throws an ignore_error exception.

ignore() [3/4]

static void tunit::base_assert::ignore ( const std::string &  message )

inlinestaticinherited

Ignore current test.

This is used by the other Assert functions.

Parameters

message

A user message to display if the assertion fails. This message can be seen in the unit test results.

Examples

tunit::assert::ignore("User message...", line_info_); // test throws an ignore_error exception.

ignore() [4/4]

static void tunit::base_assert::ignore ( const std::string &  message, const tunit::line_info &  line_info  )

staticinherited

Ignore current test.

This is used by the other Assert functions.

Parameters

message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples

tunit::assert::ignore("User message...", line_info_); // test throws an ignore_error exception.

is_empty() [1/4]

template<typename TValue >

static void tunit::assert::is_empty ( const TValue &  value )

inlinestatic

Asserts that collection contains an item.

Parameters

value

The value to check is empty.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1;
std::vector<int> v2 = {0, 1, 2, 3};
tunit::assert::is_empty(v1); // test ok.
tunit::assert::is_empty(v2); // test throws an assertion_error exception.

is_empty() [2/4]

template<typename TValue >

static void tunit::assert::is_empty ( const TValue &  value, const tunit::line_info &  line_info  )

inlinestatic

Asserts that collection contains an item.

Parameters

value	The value to check is empty.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1;
std::vector<int> v2 = {0, 1, 2, 3};
tunit::assert::is_empty(v1, line_info_); // test ok.
tunit::assert::is_empty(v2, line_info_); // test throws an assertion_error exception.

is_empty() [3/4]

template<typename TValue >

static void tunit::assert::is_empty ( const TValue &  value, const std::string &  message  )

inlinestatic

Asserts that collection contains an item.

Parameters

value	The value to check is empty.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1;
std::vector<int> v2 = {0, 1, 2, 3};
tunit::assert::is_empty(v1, "User message..."); // test ok.
tunit::assert::is_empty(v2, "User message..."); // test throws an assertion_error exception.

is_empty() [4/4]

template<typename TValue >

static void tunit::assert::is_empty ( const TValue &  value, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that collection contains an item.

Parameters

value	The value to check is empty.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1;
std::vector<int> v2 = {0, 1, 2, 3};
tunit::assert::is_empty(v1, "User message...", line_info_); // test ok.
tunit::assert::is_empty(v2, "User message...", line_info_); // test throws an assertion_error exception.

is_false() [1/4]

static void tunit::assert::is_false ( bool  condition )

inlinestatic

Asserts that ta condition is false.

Parameters

condition

The condition to check is false.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::string s1 = "Anything";
std::string s2;
tunit::assert::is_false(std::empty(s1)); // test ok.
tunit::assert::is_false(std::empty(s2)); // test throws an assertion_error exception.

is_false() [2/4]

static void tunit::assert::is_false ( bool  condition, const tunit::line_info &  line_info  )

inlinestatic

Asserts that a condition is false.

Parameters

condition	The condition to check is false.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::string s1 = "Anything";
std::string s2;
tunit::assert::is_false(std::empty(s1), line_info_); // test ok.
tunit::assert::is_false(std::empty(s2), line_info_); // test throws an assertion_error exception.

is_false() [3/4]

static void tunit::assert::is_false ( bool  condition, const std::string &  message  )

inlinestatic

Asserts that a condition is false.

Parameters

condition	The condition to check is false.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::string s1 = "Anything";
std::string s2;
tunit::assert::is_false(std::empty(s1), "User message..."); // test ok.
tunit::assert::is_false(std::empty(s2), "User message..."); // test throws an assertion_error exception.

is_false() [4/4]

static void tunit::assert::is_false ( bool  condition, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that a condition is false.

Parameters

condition	The condition to check is false.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::string s1 = "Anything";
std::string s2;
tunit::assert::is_false(std::empty(s1), "User message...", line_info_); // test ok.
tunit::assert::is_false(std::empty(s2), "User message...", line_info_); // test throws an assertion_error exception.

is_greater() [1/4]

template<typename TValue1 , typename TValue2 >

static void tunit::assert::is_greater ( const TValue1 &  val1, const TValue2 &  val2  )

inlinestatic

Asserts that the first value is greater than the second value.

Parameters

val1	the first value.
val2	the second value.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::is_greater(24, 12); // test ok.
tunit::assert::is_greater(24, 48); // test throws an assertion_error exception.

is_greater() [2/4]

template<typename TValue1 , typename TValue2 >

static void tunit::assert::is_greater ( const TValue1 &  val1, const TValue2 &  val2, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the first value is greater than the second value.

Parameters

val1	the first value.
val2	the second value.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::is_greater(24, 12, line_info_); // test ok.
tunit::assert::is_greater(24, 48, line_info_); // test throws an assertion_error exception.

is_greater() [3/4]

template<typename TValue1 , typename TValue2 >

static void tunit::assert::is_greater ( const TValue1 &  val1, const TValue2 &  val2, const std::string &  message  )

inlinestatic

Asserts that the first value is greater than the second value.

Parameters

val1	the first value.
val2	the second value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::is_greater(24, 12, "User message..."); // test ok.
tunit::assert::is_greater(24, 48, "User message..."); // test throws an assertion_error exception.

is_greater() [4/4]

template<typename TValue1 , typename TValue2 >

static void tunit::assert::is_greater ( const TValue1 &  val1, const TValue2 &  val2, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the first value is greater than the second value.

Parameters

val1	the first value.
val2	the second value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::is_greater(24, 12, "User message...", line_info_); // test ok.
tunit::assert::is_greater(24, 48, "User message...", line_info_); // test throws an assertion_error exception.

is_greater_or_equal() [1/4]

template<typename TValue1 , typename TValue2 >

static void tunit::assert::is_greater_or_equal ( const TValue1 &  val1, const TValue2 &  val2  )

inlinestatic

Asserts that the first value is greater than or equal to the second value.

Parameters

val1	the first value.
val2	the second value.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::is_greater_or_equal(24, 12); // test ok.
tunit::assert::is_greater_or_equal(24, 24); // test ok.
tunit::assert::is_greater_or_equal(24, 48); // test throws an assertion_error exception.

is_greater_or_equal() [2/4]

template<typename TValue1 , typename TValue2 >

static void tunit::assert::is_greater_or_equal ( const TValue1 &  val1, const TValue2 &  val2, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the first value is greater than or equal to the second value.

Parameters

val1	the first value.
val2	the second value.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::is_greater_or_equal(24, 12, line_info_); // test ok.
tunit::assert::is_greater_or_equal(24, 24, line_info_); // test ok.
tunit::assert::is_greater_or_equal(24, 48, line_info_); // test throws an assertion_error exception.

is_greater_or_equal() [3/4]

template<typename TValue1 , typename TValue2 >

static void tunit::assert::is_greater_or_equal ( const TValue1 &  val1, const TValue2 &  val2, const std::string &  message  )

inlinestatic

Asserts that the first value is greater than or equal to the second value.

Parameters

val1	the first value.
val2	the second value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::is_greater_or_equal(24, 12, "User message..."); // test ok.
tunit::assert::is_greater_or_equal(24, 24, "User message..."); // test ok.
tunit::assert::is_greater_or_equal(24, 48, "User message..."); // test throws an assertion_error exception.

is_greater_or_equal() [4/4]

template<typename TValue1 , typename TValue2 >

static void tunit::assert::is_greater_or_equal ( const TValue1 &  val1, const TValue2 &  val2, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the first value is greater than or equal to the second value.

Parameters

val1	the first value.
val2	the second value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::is_greater_or_equal(24, 12, "User message...", line_info_); // test ok.
tunit::assert::is_greater_or_equal(24, 24, "User message...", line_info_); // test ok.
tunit::assert::is_greater_or_equal(24, 48, "User message...", line_info_); // test throws an assertion_error exception.

is_instance_of() [1/4]

template<typename Type , typename TValue >

static void tunit::assert::is_instance_of ( const TValue &  value )

inlinestatic

Asserts that an object is of the type supplied or a derived type.

Parameters

value

The object to verify

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::invalid_argument except("invalid argument");
tunit::assert::is_instance_of<std::logic_error>(except); // test ok.
tunit::assert::is_instance_of<std::bad_cast>(except); test throws an assertion_error exception.

is_instance_of() [2/4]

template<typename Type , typename TValue >

static void tunit::assert::is_instance_of ( const TValue &  value, const tunit::line_info &  line_info  )

inlinestatic

Asserts that an object is of the type supplied or a derived type.

Parameters

value	The object to verify
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::invalid_argument except("invalid argument");
tunit::assert::is_instance_of<std::logic_error>(except, line_info_); // test ok.
tunit::assert::is_instance_of<std::bad_cast>(except, line_info_); test throws an assertion_error exception.

is_instance_of() [3/4]

template<typename Type , typename TValue >

static void tunit::assert::is_instance_of ( const TValue &  value, const std::string &  message  )

inlinestatic

Asserts that an object is of the type supplied or a derived type.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::invalid_argument except("invalid argument");
tunit::assert::is_instance_of<std::logic_error>(except, "User message..."); // test ok.
tunit::assert::is_instance_of<std::bad_cast>(except, "User message..."); test throws an assertion_error exception.

is_instance_of() [4/4]

template<typename Type , typename TValue >

static void tunit::assert::is_instance_of ( const TValue &  value, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that an object is of the type supplied or a derived type.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::invalid_argument except("invalid argument");
tunit::assert::is_instance_of<std::logic_error>(except, "User message...", line_info_); // test ok.
tunit::assert::is_instance_of<std::bad_cast>(except, "User message...", line_info_); test throws an assertion_error exception.

is_less() [1/4]

template<typename TValue1 , typename TValue2 >

static void tunit::assert::is_less ( const TValue1 &  val1, const TValue2 &  val2  )

inlinestatic

Asserts that the first value is is_less than the second value.

Parameters

val1	the first value.
val2	the second value.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::is_less(24, 48); // test ok.
tunit::assert::is_less(24, 12); // test throws an assertion_error exception.

is_less() [2/4]

template<typename TValue1 , typename TValue2 >

static void tunit::assert::is_less ( const TValue1 &  val1, const TValue2 &  val2, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the first value is is_less than the second value.

Parameters

val1	the first value.
val2	the second value.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::is_less(24, 48, line_info_); // test ok.
tunit::assert::is_less(24, 12, line_info_); // test throws an assertion_error exception.

is_less() [3/4]

template<typename TValue1 , typename TValue2 >

static void tunit::assert::is_less ( const TValue1 &  val1, const TValue2 &  val2, const std::string &  message  )

inlinestatic

Asserts that the first value is is_less than the second value.

Parameters

val1	the first value.
val2	the second value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::is_less(24, 48, "User message..."); // test ok.
tunit::assert::is_less(24, 12, "User message..."); // test throws an assertion_error exception.

is_less() [4/4]

template<typename TValue1 , typename TValue2 >

static void tunit::assert::is_less ( const TValue1 &  val1, const TValue2 &  val2, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the first value is is_less than the second value.

Parameters

val1	the first value.
val2	the second value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::is_less(24, 48, "User message...", line_info_); // test ok.
tunit::assert::is_less(24, 12, "User message...", line_info_); // test throws an assertion_error exception.

is_less_or_equal() [1/4]

template<typename TValue1 , typename TValue2 >

static void tunit::assert::is_less_or_equal ( const TValue1 &  val1, const TValue2 &  val2  )

inlinestatic

Asserts that the first value is is_less than or equal to the second value.

Parameters

val1	the first value.
val2	the second value.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::is_less_or_equal(24, 48); // test ok.
tunit::assert::is_less_or_equal(24, 24); // test ok.
tunit::assert::is_less_or_equal(24, 12); // test throws an assertion_error exception.

is_less_or_equal() [2/4]

template<typename TValue1 , typename TValue2 >

static void tunit::assert::is_less_or_equal ( const TValue1 &  val1, const TValue2 &  val2, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the first value is is_less than or equal to the second value.

Parameters

val1	the first value.
val2	the second value.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::is_less_or_equal(24, 48, line_info_); // test ok.
tunit::assert::is_less_or_equal(24, 24, line_info_); // test ok.
tunit::assert::is_less_or_equal(24, 12, line_info_); // test throws an assertion_error exception.

is_less_or_equal() [3/4]

template<typename TValue1 , typename TValue2 >

static void tunit::assert::is_less_or_equal ( const TValue1 &  val1, const TValue2 &  val2, const std::string &  message  )

inlinestatic

Asserts that the first value is is_less than or equal to the second value.

Parameters

val1	the first value.
val2	the second value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::is_less_or_equal(24, 48, "User message..."); // test ok.
tunit::assert::is_less_or_equal(24, 24, "User message..."); // test ok.
tunit::assert::is_less_or_equal(24, 12, "User message..."); // test throws an assertion_error exception.

is_less_or_equal() [4/4]

template<typename TValue1 , typename TValue2 >

static void tunit::assert::is_less_or_equal ( const TValue1 &  val1, const TValue2 &  val2, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the first value is is_less than or equal to the second value.

Parameters

val1	the first value.
val2	the second value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

tunit::assert::is_less_or_equal(24, 48, "User message...", line_info_); // test ok.
tunit::assert::is_less_or_equal(24, 24, "User message...", line_info_); // test ok.
tunit::assert::is_less_or_equal(24, 12, "User message...", line_info_); // test throws an assertion_error exception.

is_NaN() [1/12]

static void tunit::assert::is_NaN ( double  value )

inlinestatic

that a value is NaN.

Parameters

value

The value to check is NaN.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

double v1 = std::numeric_limits<double>::quiet_NaN();
double v2 = 3.14159265358979323846;
tunit::assert::is_NaN(v1); // test ok.
tunit::assert::is_NaN(v2); // test throws an assertion_error exception.

is_NaN() [2/12]

static void tunit::assert::is_NaN ( double  value, const tunit::line_info &  line_info  )

inlinestatic

that a value is NaN.

Parameters

value	The value to check is NaN.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

double v1 = std::numeric_limits<double>::quiet_NaN();
double v2 = 3.14159265358979323846;
tunit::assert::is_NaN(v1, line_info_); // test ok.
tunit::assert::is_NaN(v2, line_info_); // test throws an assertion_error exception.

is_NaN() [3/12]

static void tunit::assert::is_NaN ( double  value, const std::string &  message  )

inlinestatic

Asserts that a value is NaN.

Parameters

value	The value to check is NaN.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

double v1 = std::numeric_limits<double>::quiet_NaN();
double v2 = 3.14159265358979323846;
tunit::assert::is_NaN(v1, "User message..."); // test ok.
tunit::assert::is_NaN(v2, "User message..."); // test throws an assertion_error exception.

is_NaN() [4/12]

static void tunit::assert::is_NaN ( double  value, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that a value is NaN.

Parameters

value	The value to check is NaN.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

double v1 = std::numeric_limits<double>::quiet_NaN();
double v2 = 3.14159265358979323846;
tunit::assert::is_NaN(v1, "User message...", line_info_); // test ok.
tunit::assert::is_NaN(v2, "User message...", line_info_); // test throws an assertion_error exception.

is_NaN() [5/12]

static void tunit::assert::is_NaN ( long double  value )

inlinestatic

that a value is NaN.

Parameters

value

The value to check is NaN.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

long double v1 = std::numeric_limits<double>::quiet_NaN();
long double v2 = 3.14159265358979323846l;
tunit::assert::is_NaN(v1); // test ok.
tunit::assert::is_NaN(v2); // test throws an assertion_error exception.

is_NaN() [6/12]

static void tunit::assert::is_NaN ( long double  value, const tunit::line_info &  line_info  )

inlinestatic

that a value is NaN.

Parameters

value	The value to check is NaN.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

long double v1 = std::numeric_limits<long double>::quiet_NaN();
long double v2 = 3.14159265358979323846l;
tunit::assert::is_NaN(v1, line_info_); // test ok.
tunit::assert::is_NaN(v2, line_info_); // test throws an assertion_error exception.

is_NaN() [7/12]

static void tunit::assert::is_NaN ( long double  value, const std::string &  message  )

inlinestatic

Asserts that a value is NaN.

Parameters

value	The value to check is NaN.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

long double v1 = std::numeric_limits<long double>::quiet_NaN();
long double v2 = 3.14159265358979323846l;
tunit::assert::is_NaN(v1, "User message..."); // test ok.
tunit::assert::is_NaN(v2, "User message..."); // test throws an assertion_error exception.

is_NaN() [8/12]

static void tunit::assert::is_NaN ( long double  value, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that a value is NaN.

Parameters

value	The value to check is NaN.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

long double v1 = std::numeric_limits<long double>::quiet_NaN();
long double v2 = 3.14159265358979323846l;
tunit::assert::is_NaN(v1, "User message...", line_info_); // test ok.
tunit::assert::is_NaN(v2, "User message...", line_info_); // test throws an assertion_error exception.

is_NaN() [9/12]

static void tunit::assert::is_NaN ( float  value )

inlinestatic

that a value is NaN.

Parameters

value

The value to check is NaN.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

float v1 = std::numeric_limits<float>::quiet_NaN();
float v2 = 3.14159265358979323846;
tunit::assert::is_NaN(v1); // test ok.
tunit::assert::is_NaN(v2); // test throws an assertion_error exception.

is_NaN() [10/12]

static void tunit::assert::is_NaN ( float  value, const tunit::line_info &  line_info  )

inlinestatic

that a value is NaN.

Parameters

value	The value to check is NaN.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

float v1 = std::numeric_limits<float>::quiet_NaN();
float v2 = 3.14159265358979323846;
tunit::assert::is_NaN(v1, line_info_); // test ok.
tunit::assert::is_NaN(v2, line_info_); // test throws an assertion_error exception.

is_NaN() [11/12]

static void tunit::assert::is_NaN ( float  value, const std::string &  message  )

inlinestatic

Asserts that a value is NaN.

Parameters

value	The value to check is NaN.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

float v1 = std::numeric_limits<float>::quiet_NaN();
float v2 = 3.14159265358979323846;
tunit::assert::is_NaN(v1, "User message..."); // test ok.
tunit::assert::is_NaN(v2, "User message..."); // test throws an assertion_error exception.

is_NaN() [12/12]

static void tunit::assert::is_NaN ( float  value, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that a value is NaN.

Parameters

value	The value to check is NaN.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

float v1 = std::numeric_limits<float>::quiet_NaN();
float v2 = 3.14159265358979323846;
tunit::assert::is_NaN(v1, "User message...", line_info_); // test ok.
tunit::assert::is_NaN(v2, "User message...", line_info_); // test throws an assertion_error exception.

is_negative() [1/4]

template<typename TValue >

static void tunit::assert::is_negative ( const TValue &  value )

inlinestatic

Asserts that ta condition is negative.

Parameters

value

The value to check is negative.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int i1 = -1;
int i2 = 1;
tunit::assert::is_negative(i1); // test ok.
tunit::assert::is_negative(i2); // test throws an assertion_error exception.

is_negative() [2/4]

template<typename TValue >

static void tunit::assert::is_negative ( const TValue &  value, const tunit::line_info &  line_info  )

inlinestatic

Asserts that ta condition is negative.

Parameters

value	The value to check is negative.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int i1 = -1;
int i2 = 1;
tunit::assert::is_negative(i1, line_info_); // test ok.
tunit::assert::is_negative(i2, line_info_); // test throws an assertion_error exception.

is_negative() [3/4]

template<typename TValue >

static void tunit::assert::is_negative ( const TValue &  value, const std::string &  message  )

inlinestatic

Asserts that ta condition is negative.

Parameters

value	The value to check is negative.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int i1 = -1;
int i2 = 1;
tunit::assert::is_negative(i1, "User message..."); // test ok.
tunit::assert::is_negative(i2, "User message..."); // test throws an assertion_error exception.

is_negative() [4/4]

template<typename TValue >

static void tunit::assert::is_negative ( const TValue &  value, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that ta condition is negative.

Parameters

value	The value to check is negative.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int i1 = -1;
int i2 = 1;
tunit::assert::is_negative(i1, "User message...", line_info_); // test ok.
tunit::assert::is_negative(i2, "User message...", line_info_); // test throws an assertion_error exception.

is_not_empty() [1/4]

template<typename TValue >

static void tunit::assert::is_not_empty ( const TValue &  value )

inlinestatic

Asserts that collection oes not contain any item.

Parameters

value

The value to check is empty.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {0, 1, 2, 3};
std::vector<int> v2;
tunit::assert::is_not_empty(v1); // test ok.
tunit::assert::is_not_empty(v2); // test throws an assertion_error exception.

is_not_empty() [2/4]

template<typename TValue >

static void tunit::assert::is_not_empty ( const TValue &  value, const tunit::line_info &  line_info  )

inlinestatic

Asserts that collection does not contain any item.

Parameters

value	The value to check is empty.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {0, 1, 2, 3};
std::vector<int> v2;
tunit::assert::is_not_empty(v1, line_info_); // test ok.
tunit::assert::is_not_empty(v2, line_info_); // test throws an assertion_error exception.

is_not_empty() [3/4]

template<typename TValue >

static void tunit::assert::is_not_empty ( const TValue &  value, const std::string &  message  )

inlinestatic

Asserts that collection does not contain any item.

Parameters

value	The value to check is empty.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {0, 1, 2, 3};
std::vector<int> v2;
tunit::assert::is_not_empty(v1, "User message..."); // test ok.
tunit::assert::is_not_empty(v2, "User message..."); // test throws an assertion_error exception.

is_not_empty() [4/4]

template<typename TValue >

static void tunit::assert::is_not_empty ( const TValue &  value, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that collection does not contain any item.

Parameters

value	The value to check is empty.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {0, 1, 2, 3};
std::vector<int> v2;
tunit::assert::is_not_empty(v1, "User message...", line_info_); // test ok.
tunit::assert::is_not_empty(v2, "User message...", line_info_); // test throws an assertion_error exception.

is_not_instance_of() [1/4]

template<typename Type , typename TValue >

static void tunit::assert::is_not_instance_of ( const TValue &  value )

inlinestatic

Asserts that an object is not of the type supplied or a derived type.

Parameters

value

The object to verify

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::invalid_argument except("invalid argument");
tunit::assert::is_not_instance_of<std::bad_cast>(except); // test ok.
tunit::assert::is_not_instance_of<std::logic_error>(except); test throws an assertion_error exception.

is_not_instance_of() [2/4]

template<typename Type , typename TValue >

static void tunit::assert::is_not_instance_of ( const TValue &  value, const tunit::line_info &  line_info  )

inlinestatic

Asserts that an object is not of the type supplied or a derived type.

Parameters

value	The object to verify
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::invalid_argument except("invalid argument");
tunit::assert::is_not_instance_of<std::bad_cast>(except, line_info_); // test ok.
tunit::assert::is_not_instance_of<std::logic_error>(except, line_info_); test throws an assertion_error exception.

is_not_instance_of() [3/4]

template<typename Type , typename TValue >

static void tunit::assert::is_not_instance_of ( const TValue &  value, const std::string &  message  )

inlinestatic

Asserts that an object is not of the type supplied or a derived type.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::invalid_argument except("invalid argument");
tunit::assert::is_not_instance_of<std::bad_cast>(except, "User message..."); // test ok.
tunit::assert::is_not_instance_of<std::logic_error>(except, "User message..."); test throws an assertion_error exception.

is_not_instance_of() [4/4]

template<typename Type , typename TValue >

static void tunit::assert::is_not_instance_of ( const TValue &  value, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that an object is not of the type supplied or a derived type.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::invalid_argument except("invalid argument");
tunit::assert::is_not_instance_of<std::bad_cast>(except, "User message...", line_info_); // test ok.
tunit::assert::is_not_instance_of<std::logic_error>(except, "User message...", line_info_); test throws an assertion_error exception.

is_not_null() [1/20]

template<typename TPointer >

static void tunit::assert::is_not_null ( const TPointer *  pointer )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer

The pointer to check is null.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::string str = "Anything";
std::string* s1 = &str;
std::string* s2 = nullptr;
tunit::assert::is_not_null(s1); // test ok.
tunit::assert::is_not_null(s2); // test throws an assertion_error exception.

is_not_null() [2/20]

template<typename TPointer >

static void tunit::assert::is_not_null ( const TPointer *  pointer, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer	The pointer to check is null.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::string str = "Anything";
std::string* s1 = &str;
std::string* s2 = nullptr;
tunit::assert::is_not_null(s1, line_info_); // test ok.
tunit::assert::is_not_null(s2, line_info_); // test throws an assertion_error exception.

is_not_null() [3/20]

template<typename TPointer >

static void tunit::assert::is_not_null ( const TPointer *  pointer, const std::string &  message  )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::string str = "Anything";
std::string* s1 = &str;
std::string* s2 = nullptr;
tunit::assert::is_not_null(s1, "User message..."); // test ok.
tunit::assert::is_not_null(s2, "User message..."); // test throws an assertion_error exception.

is_not_null() [4/20]

template<typename TPointer >

static void tunit::assert::is_not_null ( const TPointer *  pointer, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::string str = "Anything";
std::string* s1 = &str;
std::string* s2 = nullptr;
tunit::assert::is_not_null(s1, "User message...", line_info_); // test ok.
tunit::assert::is_not_null(s2, "User message...", line_info_); // test throws an assertion_error exception.

is_not_null() [5/20]

template<typename TPointer >

static void tunit::assert::is_not_null ( const std::unique_ptr< TPointer > &  pointer )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer

The pointer to check is null.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::unique_ptr<std::string> s1 = std::make_unique<std::string>("Anything");
std::unique_ptr<std::string> s2;
tunit::assert::is_not_null(s1); // test ok.
tunit::assert::is_not_null(s2); // test throws an assertion_error exception.

is_not_null() [6/20]

template<typename TPointer >

static void tunit::assert::is_not_null ( const std::unique_ptr< TPointer > &  pointer, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer	The pointer to check is null.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::unique_ptr<std::string> s1 = std::make_unique<std::string>("Anything");
std::unique_ptr<std::string> s2;
tunit::assert::is_not_null(s1, line_info_); // test ok.
tunit::assert::is_not_null(s2, line_info_); // test throws an assertion_error exception.

is_not_null() [7/20]

template<typename TPointer >

static void tunit::assert::is_not_null ( const std::unique_ptr< TPointer > &  pointer, const std::string &  message  )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::unique_ptr<std::string> s1 = std::make_unique<std::string>("Anything");
std::unique_ptr<std::string> s2;
tunit::assert::is_not_null(s1, "User message..."); // test ok.
tunit::assert::is_not_null(s2, "User message..."); // test throws an assertion_error exception.

is_not_null() [8/20]

template<typename TPointer >

static void tunit::assert::is_not_null ( const std::unique_ptr< TPointer > &  pointer, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::unique_ptr<std::string> s1 = std::make_unique<std::string>("Anything");
std::unique_ptr<std::string> s2;
tunit::assert::is_not_null(s1, "User message...", line_info_); // test ok.
tunit::assert::is_not_null(s2, "User message...", line_info_); // test throws an assertion_error exception.

is_not_null() [9/20]

template<typename TPointer >

static void tunit::assert::is_not_null ( const std::shared_ptr< TPointer > &  pointer )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer

The pointer to check is null.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::shared_ptr<std::string> s1 = std::make_shared<std::string>("Anything");
std::shared_ptr<std::string> s2;
tunit::assert::is_not_null(s1); // test ok.
tunit::assert::is_not_null(s2); // test throws an assertion_error exception.

is_not_null() [10/20]

template<typename TPointer >

static void tunit::assert::is_not_null ( const std::shared_ptr< TPointer > &  pointer, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer	The pointer to check is null.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::shared_ptr<std::string> s1 = std::make_shared<std::string>("Anything");
std::shared_ptr<std::string> s2;
tunit::assert::is_not_null(s1, line_info_); // test ok.
tunit::assert::is_not_null(s2, line_info_); // test throws an assertion_error exception.

is_not_null() [11/20]

template<typename TPointer >

static void tunit::assert::is_not_null ( const std::shared_ptr< TPointer > &  pointer, const std::string &  message  )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::shared_ptr<std::string> s1 = std::make_shared<std::string>("Anything");
std::shared_ptr<std::string> s2;
tunit::assert::is_not_null(s1, "User message..."); // test ok.
tunit::assert::is_not_null(s2, "User message..."); // test throws an assertion_error exception.

is_not_null() [12/20]

template<typename TPointer >

static void tunit::assert::is_not_null ( const std::shared_ptr< TPointer > &  pointer, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::shared_ptr<std::string> s1 = std::make_shared<std::string>("Anything");
std::shared_ptr<std::string> s2;
tunit::assert::is_not_null(s1, "User message...", line_info_); // test ok.
tunit::assert::is_not_null(s2, "User message...", line_info_); // test throws an assertion_error exception.

is_not_null() [13/20]

template<typename TPointer >

static void tunit::assert::is_not_null ( const std::weak_ptr< TPointer > &  pointer )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer

The pointer to check is null.

Remarks

Always true, a weaptr can't be equal to nullptr by contruction or assignation.

Examples

std::shared_ptr<std::string> s = std::make_shared<std::string>("Anything");
std::weak_ptr<std::string> s1 = s;
std::weak_ptr<std::string> s2;
tunit::assert::is_not_null(s1); // test ok.
tunit::assert::is_not_null(s2); // test ok.

is_not_null() [14/20]

template<typename TPointer >

static void tunit::assert::is_not_null ( const std::weak_ptr< TPointer > &  pointer, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer	The pointer to check is null.
line_info	Contains information about current file and current line.

Remarks

Always true, a weaptr can't be equal to nullptr by contruction or assignation.

Examples

std::shared_ptr<std::string> s = std::make_shared<std::string>("Anything");
std::weak_ptr<std::string> s1 = s;
std::weak_ptr<std::string> s2;
tunit::assert::is_not_null(s1, line_info_); // test ok.
tunit::assert::is_not_null(s2, line_info_); // test ok.

is_not_null() [15/20]

template<typename TPointer >

static void tunit::assert::is_not_null ( const std::weak_ptr< TPointer > &  pointer, const std::string &  message  )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks

Always true, a weaptr can't be equal to nullptr by contruction or assignation.

Examples

std::shared_ptr<std::string> s = std::make_shared<std::string>("Anything");
std::weak_ptr<std::string> s1 = s;
std::weak_ptr<std::string> s2;
tunit::assert::is_not_null(s1, "User message..."); // test ok.
tunit::assert::is_not_null(s2, "User message..."); // test ok.

is_not_null() [16/20]

template<typename TPointer >

static void tunit::assert::is_not_null ( const std::weak_ptr< TPointer > &  pointer, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Remarks

Always true, a weaptr can't be equal to nullptr by contruction or assignation.

Examples

std::shared_ptr<std::string> s = std::make_shared<std::string>("Anything");
std::weak_ptr<std::string> s1 = s;
std::weak_ptr<std::string> s2;
tunit::assert::is_not_null(s1, "User message...", line_info_); // test ok.
tunit::assert::is_not_null(s2, "User message...", line_info_); // test ok.

is_not_null() [17/20]

static void tunit::assert::is_not_null ( std::nullptr_t  pointer )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer

The pointer to check is null.

Exceptions

tunit::assertion_error

If bad assertion.

Remarks

Always false, a nullptr_t is always equal to nullptr.

Examples

tunit::assert::is_not_null(nullptr); // test throws an assertion_error exception.

is_not_null() [18/20]

static void tunit::assert::is_not_null ( std::nullptr_t  pointer, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer	The pointer to check is null.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Remarks

Always false, a nullptr_t is always equal to nullptr.

Examples

tunit::assert::is_not_null(nullptr, line_info_); // test throws an assertion_error exception.

is_not_null() [19/20]

static void tunit::assert::is_not_null ( std::nullptr_t  pointer, const std::string &  message  )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Remarks

Always false, a nullptr_t is always equal to nullptr.

Examples

tunit::assert::is_not_null(nullptr, "User message..."); // test throws an assertion_error exception.

is_not_null() [20/20]

static void tunit::assert::is_not_null ( std::nullptr_t  pointer, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is not null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Remarks

Always false, a nullptr_t is always equal to nullptr.

Examples

tunit::assert::is_not_null(nullptr, "User message...", line_info_); // test throws an assertion_error exception.

is_not_zero() [1/4]

template<typename TValue >

static void tunit::assert::is_not_zero ( const TValue &  value )

inlinestatic

Asserts that ta condition is not zero.

Parameters

value

The value to check is not zero.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int i1 = 42;
int i2 = 0;
tunit::assert::is_not_zero(i1); // test ok.
tunit::assert::is_not_zero(i2); // test throws an assertion_error exception.

is_not_zero() [2/4]

template<typename TValue >

static void tunit::assert::is_not_zero ( const TValue &  value, const tunit::line_info &  line_info  )

inlinestatic

Asserts that ta condition is not zero.

Parameters

value	The value to check is not zero.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int i1 = 42;
int i2 = 0;
tunit::assert::is_not_zero(i1, line_info_); // test ok.
tunit::assert::is_not_zero(i2, line_info_); // test throws an assertion_error exception.

is_not_zero() [3/4]

template<typename TValue >

static void tunit::assert::is_not_zero ( const TValue &  value, const std::string &  message  )

inlinestatic

Asserts that ta condition is not zero.

Parameters

value	The value to check is not zero.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int i1 = 42;
int i2 = 0;
tunit::assert::is_not_zero(i1, "User message..."); // test ok.
tunit::assert::is_not_zero(i2, "User message..."); // test throws an assertion_error exception.

is_not_zero() [4/4]

template<typename TValue >

static void tunit::assert::is_not_zero ( const TValue &  value, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that ta condition is not zero.

Parameters

value	The value to check is not zero.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int i1 = 42;
int i2 = 0;
tunit::assert::is_not_zero(i1, "User message...", line_info_); // test ok.
tunit::assert::is_not_zero(i2, "User message...", line_info_); // test throws an assertion_error exception.

is_null() [1/20]

template<typename TPointer >

static void tunit::assert::is_null ( const TPointer *  pointer )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer

The pointer to check is null.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::string str = "Anything";
std::string* s1 = nullptr;
std::string* s2 = &str;
tunit::assert::is_null(s1); // test ok.
tunit::assert::is_null(s2); // test throws an assertion_error exception.

is_null() [2/20]

template<typename TPointer >

static void tunit::assert::is_null ( const TPointer *  pointer, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer	The pointer to check is null.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::string str = "Anything";
std::string* s1 = nullptr;
std::string* s2 = &str;
tunit::assert::is_null(s1, line_info_); // test ok.
tunit::assert::is_null(s2, line_info_); // test throws an assertion_error exception.

is_null() [3/20]

template<typename TPointer >

static void tunit::assert::is_null ( const TPointer *  pointer, const std::string &  message  )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::string str = "Anything";
std::string* s1 = nullptr;
std::string* s2 = &str;
tunit::assert::is_null(s1, "User message..."); // test ok.
tunit::assert::is_null(s2, "User message..."); // test throws an assertion_error exception.

is_null() [4/20]

template<typename TPointer >

static void tunit::assert::is_null ( const TPointer *  pointer, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::string str = "Anything";
std::string* s1 = nullptr;
std::string* s2 = &str;
tunit::assert::is_null(s1, "User message...", line_info_); // test ok.
tunit::assert::is_null(s2, "User message...", line_info_); // test throws an assertion_error exception.

is_null() [5/20]

template<typename TPointer >

static void tunit::assert::is_null ( const std::unique_ptr< TPointer > &  pointer )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer

The pointer to check is null.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::unique_ptr<std::string> s1;
std::unique_ptr<std::string> s2 = std::make_unique<std::string>("Anything");
tunit::assert::is_null(s1); // test ok.
tunit::assert::is_null(s2); // test throws an assertion_error exception.

is_null() [6/20]

template<typename TPointer >

static void tunit::assert::is_null ( const std::unique_ptr< TPointer > &  pointer, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer	The pointer to check is null.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::unique_ptr<std::string> s1;
std::unique_ptr<std::string> s2 = std::make_unique<std::string>("Anything");
tunit::assert::is_null(s1, line_info_); // test ok.
tunit::assert::is_null(s2, line_info_); // test throws an assertion_error exception.

is_null() [7/20]

template<typename TPointer >

static void tunit::assert::is_null ( const std::unique_ptr< TPointer > &  pointer, const std::string &  message  )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::unique_ptr<std::string> s1;
std::unique_ptr<std::string> s2 = std::make_unique<std::string>("Anything");
tunit::assert::is_null(s1, "User message..."); // test ok.
tunit::assert::is_null(s2, "User message..."); // test throws an assertion_error exception.

is_null() [8/20]

template<typename TPointer >

static void tunit::assert::is_null ( const std::unique_ptr< TPointer > &  pointer, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::unique_ptr<std::string> s1;
std::unique_ptr<std::string> s2 = std::make_unique<std::string>("Anything");
tunit::assert::is_null(s1, "User message...", line_info_); // test ok.
tunit::assert::is_null(s2, "User message...", line_info_); // test throws an assertion_error exception.

is_null() [9/20]

template<typename TPointer >

static void tunit::assert::is_null ( const std::shared_ptr< TPointer > &  pointer )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer

The pointer to check is null.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::shared_ptr<std::string> s1;
std::shared_ptr<std::string> s2 = std::make_shared<std::string>("Anything");
tunit::assert::is_null(s1); // test ok.
tunit::assert::is_null(s2); // test throws an assertion_error exception.

is_null() [10/20]

template<typename TPointer >

static void tunit::assert::is_null ( const std::shared_ptr< TPointer > &  pointer, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer	The pointer to check is null.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::shared_ptr<std::string> s1;
std::shared_ptr<std::string> s2 = std::make_shared<std::string>("Anything");
tunit::assert::is_null(s1, line_info_); // test ok.
tunit::assert::is_null(s2, line_info_); // test throws an assertion_error exception.

is_null() [11/20]

template<typename TPointer >

static void tunit::assert::is_null ( const std::shared_ptr< TPointer > &  pointer, const std::string &  message  )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::shared_ptr<std::string> s1;
std::shared_ptr<std::string> s2 = std::make_shared<std::string>("Anything");
tunit::assert::is_null(s1, "User message..."); // test ok.
tunit::assert::is_null(s2, "User message..."); // test throws an assertion_error exception.

is_null() [12/20]

template<typename TPointer >

static void tunit::assert::is_null ( const std::shared_ptr< TPointer > &  pointer, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::shared_ptr<std::string> s1;
std::shared_ptr<std::string> s2 = std::make_shared<std::string>("Anything");
tunit::assert::is_null(s1, "User message...", line_info_); // test ok.
tunit::assert::is_null(s2, "User message...", line_info_); // test throws an assertion_error exception.

is_null() [13/20]

template<typename TPointer >

static void tunit::assert::is_null ( const std::weak_ptr< TPointer > &  pointer )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer

The pointer to check is null.

Remarks

Always false, a weaptr can't be equal to nullptr by contruction or assignation.

Examples

std::shared_ptr<std::string> s = std::make_shared<std::string>("Anything");
std::weak_ptr<std::string> s1;
std::weak_ptr<std::string> s2 = s;
tunit::assert::is_null(s1); // test throws an assertion_error exception.
tunit::assert::is_null(s2); // test throws an assertion_error exception.

is_null() [14/20]

template<typename TPointer >

static void tunit::assert::is_null ( const std::weak_ptr< TPointer > &  pointer, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer	The pointer to check is null.
line_info	Contains information about current file and current line.

Remarks

Always false, a weaptr can't be equal to nullptr by contruction or assignation.

Examples

std::shared_ptr<std::string> s = std::make_shared<std::string>("Anything");
std::weak_ptr<std::string> s1;
std::weak_ptr<std::string> s2 = s;
tunit::assert::is_null(s1, line_info_); // test throws an assertion_error exception.
tunit::assert::is_null(s2, line_info_); // test throws an assertion_error exception.

is_null() [15/20]

template<typename TPointer >

static void tunit::assert::is_null ( const std::weak_ptr< TPointer > &  pointer, const std::string &  message  )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks

Always false, a weaptr can't be equal to nullptr by contruction or assignation.

Examples

std::shared_ptr<std::string> s = std::make_shared<std::string>("Anything");
std::weak_ptr<std::string> s1;
std::weak_ptr<std::string> s2 = s;
tunit::assert::is_null(s1, "User message..."); // test throws an assertion_error exception.
tunit::assert::is_null(s2, "User message..."); // test throws an assertion_error exception.

is_null() [16/20]

template<typename TPointer >

static void tunit::assert::is_null ( const std::weak_ptr< TPointer > &  pointer, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Remarks

Always false, a weaptr can't be equal to nullptr by contruction or assignation.

Examples

std::shared_ptr<std::string> s = std::make_shared<std::string>("Anything");
std::weak_ptr<std::string> s1;
std::weak_ptr<std::string> s2 = s;
tunit::assert::is_null(s1, "User message...", line_info_); // test throws an assertion_error exception.
tunit::assert::is_null(s2, "User message...", line_info_); // test throws an assertion_error exception.

is_null() [17/20]

static void tunit::assert::is_null ( std::nullptr_t  pointer )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer

The pointer to check is null.

Exceptions

tunit::assertion_error

If bad assertion.

Remarks

Always false, a nullptr_t is always equal to nullptr.

Examples

tunit::assert::is_null(nullptr); // test ok.

is_null() [18/20]

static void tunit::assert::is_null ( std::nullptr_t  pointer, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer	The pointer to check is null.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Remarks

Always false, a nullptr_t is always equal to nullptr.

Examples

tunit::assert::is_null(nullptr, line_info_); // test ok.

is_null() [19/20]

static void tunit::assert::is_null ( std::nullptr_t  pointer, const std::string &  message  )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Remarks

Always false, a nullptr_t is always equal to nullptr.

Examples

tunit::assert::is_null(nullptr, "User message..."); // test ok.

is_null() [20/20]

static void tunit::assert::is_null ( std::nullptr_t  pointer, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the pointer is null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Remarks

Always false, a nullptr_t is always equal to nullptr.

Examples

tunit::assert::is_null(nullptr, "User message...", line_info_); // test ok.

is_positive() [1/4]

template<typename TValue >

static void tunit::assert::is_positive ( const TValue &  value )

inlinestatic

Asserts that ta condition is positive.

Parameters

value

The value to check is positive.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int i1 = 1;
int i2 = -1;
tunit::assert::is_positive(i1); // test ok.
tunit::assert::is_positive(i2); // test throws an assertion_error exception.

is_positive() [2/4]

template<typename TValue >

static void tunit::assert::is_positive ( const TValue &  value, const tunit::line_info &  line_info  )

inlinestatic

Asserts that ta condition is positive.

Parameters

value	The value to check is positive.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int i1 = 1;
int i2 = -1;
tunit::assert::is_positive(i1, line_info_); // test ok.
tunit::assert::is_positive(i2, line_info_); // test throws an assertion_error exception.

is_positive() [3/4]

template<typename TValue >

static void tunit::assert::is_positive ( const TValue &  value, const std::string &  message  )

inlinestatic

Asserts that ta condition is positive.

Parameters

value	The value to check is positive.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int i1 = 1;
int i2 = -1;
tunit::assert::is_positive(i1, "User message..."); // test ok.
tunit::assert::is_positive(i2, "User message..."); // test throws an assertion_error exception.

is_positive() [4/4]

template<typename TValue >

static void tunit::assert::is_positive ( const TValue &  value, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that ta condition is positive.

Parameters

value	The value to check is positive.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int i1 = 1;
int i2 = -1;
tunit::assert::is_positive(i1, "User message...", line_info_); // test ok.
tunit::assert::is_positive(i2, "User message...", line_info_); // test throws an assertion_error exception.

is_true() [1/4]

static void tunit::assert::is_true ( bool  condition )

inlinestatic

Asserts that ta condition is true.

Parameters

condition

The condition to check is true.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::string s1;
std::string s2 = "Anything";
tunit::assert::is_false(std::empty(s1)); // test ok.
tunit::assert::is_false(std::empty(s2)); // test throws an assertion_error exception.

is_true() [2/4]

static void tunit::assert::is_true ( bool  condition, const tunit::line_info &  line_info  )

inlinestatic

Asserts that a condition is true.

Parameters

condition	The condition to check is true.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::string s1;
std::string s2 = "Anything";
tunit::assert::is_false(std::empty(s1), line_info_); // test ok.
tunit::assert::is_false(std::empty(s2), line_info_); // test throws an assertion_error exception.

is_true() [3/4]

static void tunit::assert::is_true ( bool  condition, const std::string &  message  )

inlinestatic

Asserts that a condition is true.

Parameters

condition	The condition to check is true.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::string s1;
std::string s2 = "Anything";
tunit::assert::is_false(std::empty(s1), "User message..."); // test ok.
tunit::assert::is_false(std::empty(s2), "User message..."); // test throws an assertion_error exception.

is_true() [4/4]

static void tunit::assert::is_true ( bool  condition, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that a condition is true.

Parameters

condition	The condition to check is true.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::string s1;
std::string s2 = "Anything";
tunit::assert::is_false(std::empty(s1), "User message...", line_info_); // test ok.
tunit::assert::is_false(std::empty(s2), "User message...", line_info_); // test throws an assertion_error exception.

is_zero() [1/4]

template<typename TValue >

static void tunit::assert::is_zero ( const TValue &  value )

inlinestatic

Asserts that ta condition is zero.

Parameters

value

The value to check is zero.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int i1 = 0;
int i2 = 42;
tunit::assert::is_zero(i1); // test ok.
tunit::assert::is_zero(i2); // test throws an assertion_error exception.

is_zero() [2/4]

template<typename TValue >

static void tunit::assert::is_zero ( const TValue &  value, const tunit::line_info &  line_info  )

inlinestatic

Asserts that ta condition is zero.

Parameters

value	The value to check is zero.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int i1 = 0;
int i2 = 42;
tunit::assert::is_zero(i1, line_info_); // test ok.
tunit::assert::is_zero(i2, line_info_); // test throws an assertion_error exception.

is_zero() [3/4]

template<typename TValue >

static void tunit::assert::is_zero ( const TValue &  value, const std::string &  message  )

inlinestatic

Asserts that ta condition is zero.

Parameters

value	The value to check is zero.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int i1 = 0;
int i2 = 42;
tunit::assert::is_zero(i1, "User message..."); // test ok.
tunit::assert::is_zero(i2, "User message..."); // test throws an assertion_error exception.

is_zero() [4/4]

template<typename TValue >

static void tunit::assert::is_zero ( const TValue &  value, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that ta condition is zero.

Parameters

value	The value to check is zero.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

int i1 = 0;
int i2 = 42;
tunit::assert::is_zero(i1, "User message...", line_info_); // test ok.
tunit::assert::is_zero(i2, "User message...", line_info_); // test throws an assertion_error exception.

succeed() [1/4]

static void tunit::base_assert::succeed ( )

inlinestaticinherited

Generates a success with a generic message.

This is used by the other Assert functions.

Examples

tunit::assert::succeed(); // test ok.

succeed() [2/4]

static void tunit::base_assert::succeed ( const tunit::line_info &  line_info )

inlinestaticinherited

Generates a success with a generic message.

This is used by the other Assert functions.

Parameters

message

A user message to display if the assertion fails. This message can be seen in the unit test results.

Examples

tunit::assert::succeed(line_info_); // test ok.

succeed() [3/4]

static void tunit::base_assert::succeed ( const std::string &  message )

inlinestaticinherited

Generates a success with a generic message.

This is used by the other Assert functions.

Parameters

message

A user message to display if the assertion fails. This message can be seen in the unit test results.

Examples

tunit::assert::succeed("User message..."); // test ok.

succeed() [4/4]

static void tunit::base_assert::succeed ( const std::string &  message, const tunit::line_info &  line_info  )

staticinherited

Generates a success with a generic message.

This is used by the other Assert functions.

Parameters

message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples

tunit::assert::succeed("User message...", line_info_); // test ok.

throws() [1/4]

template<typename TException >

static void tunit::assert::throws ( const std::function< void()> &  statement )

inlinestatic

Asserts that the statement throws a particular exception when called.

Parameters

TException	The exception type that must be throw.
statement	The statement that verify.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {1, 2, 3, 4};
tunit::assert::throws<std::out_of_range>([&] {v1.at(5);}); // test ok.
tunit::assert::throws<std::out_of_range>([&] {v1.at(2);}); // test throws an assertion_error exception.

throws() [2/4]

template<typename TException >

static void tunit::assert::throws ( const std::function< void()> &  statement, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the statement throws a particular exception when called.

Parameters

TException	The exception type that must be throw.
statement	The statement that verify.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {1, 2, 3, 4};
tunit::assert::throws<std::out_of_range>([&] {v1.at(5);}, line_info_); // test ok.
tunit::assert::throws<std::out_of_range>([&] {v1.at(2);}, line_info_); // test throws an assertion_error exception.

throws() [3/4]

template<typename TException >

static void tunit::assert::throws ( const std::function< void()> &  statement, const std::string &  message  )

inlinestatic

Asserts that the statement throws a particular exception when called.

Parameters

TException	The exception type that must be throw.
statement	The statement that verify.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {1, 2, 3, 4};
tunit::assert::throws<std::out_of_range>([&] {v1.at(5);}, "User message..."); // test ok.
tunit::assert::throws<std::out_of_range>([&] {v1.at(2);}, "User message..."); // test throws an assertion_error exception.

throws() [4/4]

template<typename TException >

static void tunit::assert::throws ( const std::function< void()> &  statement, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the statement throws a particular exception when called.

Parameters

TException	The exception type that must be throw.
statement	The statement that verify.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {1, 2, 3, 4};
tunit::assert::throws<std::out_of_range>([&] {v1.at(5);}, "User message...", line_info_); // test ok.
tunit::assert::throws<std::out_of_range>([&] {v1.at(2);}, "User message...", line_info_); // test throws an assertion_error exception.

throws_any() [1/4]

static void tunit::assert::throws_any ( const std::function< void()> &  statement )

inlinestatic

Asserts that the staement does not throw an exception.

Parameters

statement

The statement that verify.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {1, 2, 3, 4};
tunit::assert::throws_any([&] {v1.at(5);}); // test ok.
tunit::assert::throws_any([&] {v1.at(2);}); // test throws an assertion_error exception.

throws_any() [2/4]

static void tunit::assert::throws_any ( const std::function< void()> &  statement, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the staement does not throw an exception.

Parameters

statement	The statement that verify.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {1, 2, 3, 4};
tunit::assert::throws_any([&] {v1.at(5);}, line_info_); // test ok.
tunit::assert::throws_any([&] {v1.at(2);}, line_info_); // test throws an assertion_error exception.

throws_any() [3/4]

static void tunit::assert::throws_any ( const std::function< void()> &  statement, const std::string &  message  )

inlinestatic

Asserts that the staement does not throw an exception.

Parameters

statement	The statement that verify.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {1, 2, 3, 4};
tunit::assert::throws_any([&] {v1.at(5);}, "User message..."); // test ok.
tunit::assert::throws_any([&] {v1.at(2);}, "User message..."); // test throws an assertion_error exception.

throws_any() [4/4]

static void tunit::assert::throws_any ( const std::function< void()> &  statement, const std::string &  message, const tunit::line_info &  line_info  )

inlinestatic

Asserts that the staement does not throw an exception.

Parameters

statement	The statement that verify.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Exceptions

tunit::assertion_error

If bad assertion.

Examples

std::vector<int> v1 = {1, 2, 3, 4};
tunit::assert::throws_any([&] {v1.at(5);}, "User message...", line_info_); // test ok.
tunit::assert::throws_any([&] {v1.at(2);}, "User message...", line_info_); // test throws an assertion_error exception.

---

The documentation for this class was generated from the following file:

• assert.h