rcpputils  master
C++ API providing common utilities and data structures.
Public Member Functions | List of all members
rcpputils::AssertionException Class Reference

An assertion-like exception for halting tests if conditions are not met. More...

#include <asserts.hpp>

Inheritance diagram for rcpputils::AssertionException:
Inheritance graph
[legend]
Collaboration diagram for rcpputils::AssertionException:
Collaboration graph
[legend]

Public Member Functions

 AssertionException (const char *msg)
 Constructor for AssertionException. More...
 
virtual const char * what () const throw ()
 Get the message description of why this exception was thrown. More...
 
- Public Member Functions inherited from std::exception
what (T... args)
 
~exception (T... args)
 
operator= (T... args)
 
exception (T... args)
 

Detailed Description

An assertion-like exception for halting tests if conditions are not met.

Constructor & Destructor Documentation

◆ AssertionException()

rcpputils::AssertionException::AssertionException ( const char *  msg)
explicit

Constructor for AssertionException.

Parameters
msgThe message to display when this exception is thrown.

Member Function Documentation

◆ what()

virtual const char* rcpputils::AssertionException::what ( ) const
throw (
)
virtual

Get the message description of why this exception was thrown.

Returns
The string message

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