ChimeraTK-DeviceAccess  03.18.00
Classes | Static Public Member Functions | List of all members
ChimeraTK::ExperimentalFeatures Class Reference

Class for handling the experimental feature enable flag. More...

#include <ExperimentalFeatures.h>

Static Public Member Functions

static void enable ()
 Enable experimental features. More...
 
static void check (const std::string &featureName)
 Check if experimental features are enabled. More...
 

Detailed Description

Class for handling the experimental feature enable flag.

Definition at line 16 of file ExperimentalFeatures.h.

Member Function Documentation

◆ check()

static void ChimeraTK::ExperimentalFeatures::check ( const std::string &  featureName)
inlinestatic

Check if experimental features are enabled.

If not, the application is terminated with an error message which will contain the given name of the experimental feature the application was trying to use. Call this function in the experimental code section of the library to protect it against use without enbaled experimental features.

Definition at line 35 of file ExperimentalFeatures.h.

◆ enable()

static void ChimeraTK::ExperimentalFeatures::enable ( )
inlinestatic

Enable experimental features.

Call this function in your application if you want to use experimental features. Beware that your application is likely to break due to incompatible changes in those features!

Definition at line 22 of file ExperimentalFeatures.h.

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