Public Member Functions | Private Attributes | List of all members
fcl::detail::FailedAtThisConfiguration Class Referencefinal

#include <failed_at_this_configuration.h>

Inheritance diagram for fcl::detail::FailedAtThisConfiguration:
Inheritance graph
[legend]

Public Member Functions

 FailedAtThisConfiguration (const std::string &message)
 
const char * what () const noexcept final
 

Private Attributes

std::string message_
 

Detailed Description

A custom exception type that can be thrown in low-level code indicating that the program has reached an unexpected configuration and that the caller that ultimately has access to the collision objects and their transforms should report the configuration that led to the exception.

This is strictly an internal exception; it should always be caught and transformed into an exception that propagates to the operating system.

Recommended usage is to throw by invoking the macro FCL_THROW_UNEXPECTED_CONFIGURATION_EXCEPTION defined below. Code that exercises functionality that throws this type of exception should catch it and transform it to a std::logic_error by invoking ThrowDetailedConfiguration().

Definition at line 64 of file failed_at_this_configuration.h.

Constructor & Destructor Documentation

◆ FailedAtThisConfiguration()

fcl::detail::FailedAtThisConfiguration::FailedAtThisConfiguration ( const std::string &  message)
inline

Definition at line 67 of file failed_at_this_configuration.h.

Member Function Documentation

◆ what()

const char* fcl::detail::FailedAtThisConfiguration::what ( ) const
inlinefinalnoexcept

Definition at line 70 of file failed_at_this_configuration.h.

Member Data Documentation

◆ message_

std::string fcl::detail::FailedAtThisConfiguration::message_
private

Definition at line 73 of file failed_at_this_configuration.h.


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


fcl
Author(s):
autogenerated on Fri Apr 2 2021 02:38:02