UnexpectedEnumValueException Class Reference

Indicates that an unexpected value of an enum was encountered. More...

#include <ArmarXCore/core/exceptions/local/UnexpectedEnumValueException.h>

+ Inheritance diagram for UnexpectedEnumValueException:

Public Member Functions

const std::string & getEnumName () const
 Get the name of the enum type.
 
int getValue () const
 Get the encountered enum value.
 
template<typename EnumT>
 UnexpectedEnumValueException (const std::string &enumName, EnumT value)
 Constructor.
 
 UnexpectedEnumValueException (const std::string &enumName, int value)
 Constructor.
 
virtual ~UnexpectedEnumValueException () override=default
 Virtual destructor.
 

Detailed Description

Indicates that an unexpected value of an enum was encountered.

Definition at line 12 of file UnexpectedEnumValueException.h.

Constructor & Destructor Documentation

◆ UnexpectedEnumValueException() [1/2]

UnexpectedEnumValueException ( const std::string & enumName,
int value )

Constructor.

Parameters
enumNamethe name of the enum type
valuethe encountered value (cast to int if needed)

Definition at line 10 of file UnexpectedEnumValueException.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ UnexpectedEnumValueException() [2/2]

template<typename EnumT>
UnexpectedEnumValueException ( const std::string & enumName,
EnumT value )
inline

Constructor.

Parameters
enumNamethe name of the enum type
valuethe encountered value (is cast to int)

Definition at line 28 of file UnexpectedEnumValueException.h.

+ Here is the call graph for this function:

◆ ~UnexpectedEnumValueException()

virtual ~UnexpectedEnumValueException ( )
overridevirtualdefault

Virtual destructor.

Member Function Documentation

◆ getEnumName()

const std::string & getEnumName ( ) const

Get the name of the enum type.

Definition at line 20 of file UnexpectedEnumValueException.cpp.

◆ getValue()

int getValue ( ) const

Get the encountered enum value.

Definition at line 26 of file UnexpectedEnumValueException.cpp.


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