MIRA
Public Types | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Static Protected Attributes | Friends | List of all members
ExceptionCallStackSize Class Reference

ExceptionCallStackSize is a singleton that provides a mechanism to control the depth of the callstack that is stored with exceptions (e.g. More...

#include <error/ExceptionCallStackSize.h>

Inheritance diagram for ExceptionCallStackSize:
Inheritance graph
[legend]

Public Types

typedef Base::Type Type
 

Static Public Member Functions

static void set (unsigned int size)
 Set callstack max size. More...
 
static void reset ()
 Reset callstack start level and max size to initial default value (MIRA_MAX_CALLSTACK_SIZE). More...
 
static unsigned int get ()
 Query callstack max size. More...
 
static Typeinstance ()
 Returns a reference to the singleton instance. More...
 
static bool isDestroyed ()
 Returns true, if the singleton was already destroyed. More...
 

Protected Member Functions

 ExceptionCallStackSize ()
 

Static Protected Member Functions

static TypemakeInstance ()
 
static void destroyInstance (void)
 

Static Protected Attributes

static const unsigned int MIRA_MAX_CALLSTACK_SIZE = 16
 

Friends

class singleton::CreateUsingNew< ExceptionCallStackSize >
 

Detailed Description

ExceptionCallStackSize is a singleton that provides a mechanism to control the depth of the callstack that is stored with exceptions (e.g.

for logging).

Member Typedef Documentation

◆ Type

typedef Base::Type Type
inherited

Constructor & Destructor Documentation

◆ ExceptionCallStackSize()

ExceptionCallStackSize ( )
inlineprotected

Member Function Documentation

◆ set()

static void set ( unsigned int  size)
inlinestatic

Set callstack max size.

◆ reset()

static void reset ( )
inlinestatic

Reset callstack start level and max size to initial default value (MIRA_MAX_CALLSTACK_SIZE).

◆ get()

static unsigned int get ( )
inlinestatic

Query callstack max size.

◆ instance()

static Type& instance ( )
inlinestaticinherited

Returns a reference to the singleton instance.

Exceptions
XLogicalIf the singleton was already destroyed (dead reference) or not yet created (when using ExplicitInstantiation).

◆ isDestroyed()

static bool isDestroyed ( )
inlinestaticinherited

Returns true, if the singleton was already destroyed.

Trying to access it will result in an exception.

◆ makeInstance()

static Type* makeInstance ( )
inlinestaticprotectedinherited

◆ destroyInstance()

static void destroyInstance ( void  )
inlinestaticprotectedinherited

Friends And Related Function Documentation

◆ singleton::CreateUsingNew< ExceptionCallStackSize >

Member Data Documentation

◆ MIRA_MAX_CALLSTACK_SIZE

const unsigned int MIRA_MAX_CALLSTACK_SIZE = 16
staticprotected

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