example_reconstructmesdk_error_handling.cpp

Content

This examples shows how correct error handling is done for the one minute example.

Each method in ReconstructMe SDK returns an error code based on reme_error_t. This can be used to determine the outcome of the last invocation. In addition, methods such as reme_context_get_last_error, reme_context_get_first_error, reme_context_get_error_count, reme_context_pop_last_error and reme_context_pop_first_error provide addition error information.

Besides polling for error messages, you can register a callback function for logging messages.

Boost is only used to generate examples and is not necessary for working with this SDK.

#include <boost/test/unit_test.hpp>

#include <reconstructmesdk/reme.h>
#include <stdio.h>

BOOST_AUTO_TEST_SUITE(example_reconstructmesdk)


// A simple macro that checks for any errors and exits if a method invocation failed.
#define OK(s)                                       \
  if (s != REME_ERROR_SUCCESS) {                    \
    const char *msg;                                \
    int length;                                     \
    reme_context_get_last_error(c, &msg, &length);  \
      printf("Last error: %s", msg);                \
    reme_context_destroy(&c);                       \
    exit(-1);                                       \
  }                                                 \
      

BOOST_AUTO_TEST_CASE(error_handling_per_method)
{
  // Create a new context
  reme_context_t c;
  OK(reme_context_create(&c));

  // Compile for OpenCL device using defaults
  OK(reme_context_compile(c));
  
  // Create a new volume
  reme_volume_t v;
  OK(reme_volume_create(c, &v));
  
  // ...

  reme_context_destroy(&c);

}

// Logging callback
void on_error(reme_log_severity_t sev, const char *msg, void *user_data)
{
  switch (sev) {
    case REME_LOG_SEVERITY_INFO:
      {
        printf("INFO: %s\n", msg);
        break;
      }
    case REME_LOG_SEVERITY_WARNING:
      {
        printf("WARNING: %s\n", msg);
        break;
      }
    case REME_LOG_SEVERITY_ERROR:
      {
        printf("ERROR: %s\n", msg);
        break;
      }
  } 
}

BOOST_AUTO_TEST_CASE(error_handling_logging)
{
  // Create a new context
  reme_context_t c;
  reme_context_create(&c);

  reme_context_set_log_callback(c, on_error, 0);

  // Compile for OpenCL device using defaults
  reme_context_compile(c);
    
  // ...

  reme_context_destroy(&c);

}

BOOST_AUTO_TEST_CASE(error_handling_critical_point)
{
  // Create a new context
  reme_context_t c;
  reme_context_create(&c);

  // Compile for OpenCL device using defaults
  reme_context_compile(c);
    
  // ...

  // Perform error checking at a critical point
  int nerrors = 0;  
  reme_context_get_error_count(c, &nerrors);

  for (int i = 0; i < nerrors; ++i) {
    const char *msg;
    int length;

    reme_context_get_first_error(c, &msg, &length);
    printf("%i : %s", msg);
    reme_context_pop_first_error(c);
  }

  // ...

  reme_context_destroy(&c);

}

BOOST_AUTO_TEST_SUITE_END()