The DiCE API configuration uses the Base API configuration, see.
In particular, the DiCE API assertions are by default mapped to the Base API assertions.
The DiCE API supports quality software development with assertions. They are contained in various places in the DiCE API include files.
These tests are mapped to corresponding base API assertions by default, which in turn are switched off by default to have the performance of a release build. To activate the tests, you need to define the two macros mi_neuray_assert
and mi_neuray_assert_msg
before including the relevant include files. Defining only one of the two macros is considered an error. These macros and their parameters have the following meaning:
mi_neuray_assert(expr)
: If expr
evaluates to true
this macro shall have no effect. If expr
evaluates to false
this macro may print a diagnostic message and change the control flow of the program, such as aborting the program or throwing an exception. But it may also have no effect at all, for example if assertions are configured to be disabled.mi_neuray_assert_msg(expr, msg)
: Same behavior as mi_neuray_assert(expr)
, but the msg
text string contains additional diagnostic information that may be shown with a diagnostic message. Typical usages would contain "precondition"
or "postcondition"
as clarifying context information in the msg
parameter.See DiCE API Assertions and Base API Assertions.