HPS::Emergency Class Reference

The Emergency class is a concept class for Emergency codes. More...

#include <hps.h>

Public Types
enum	Code : uint32_t {   Code::Unknown,   Code::Fatal,   Code::SoftMemoryLimit,   Code::HardMemoryLimit }
	This describe the types of conditions that can trigger an EmergencyHandler. More...

Private Member Functions
	Emergency ()

Detailed Description

The Emergency class is a concept class for Emergency codes.

Member Enumeration Documentation

Code

enum HPS::Emergency::Code : uint32_t

strong

This describe the types of conditions that can trigger an EmergencyHandler.

Enumerator
Unknown	Emergencies type unknown.
Fatal	Fatal fault has occurred. Saving the Database is not possible and the EmergencyHandler must abort. After a fatal error, no Visualize functions may be called - to do so will result in a crash or deadlock.
SoftMemoryLimit	Soft memory limit breached. This limit is considered to be breached when Visualize has allocated the amount of memory specified by a previous call to HPS::Database::SetSoftMemoryLimit.
HardMemoryLimit	Hard memory limit breached. This limit is considered to be breached when an operating system memory allocation has failed, and indicates that Visualize is not able to allocate memory required for proceeding with normal operation.

Constructor & Destructor Documentation

Emergency()

HPS::Emergency::Emergency ( )

inlineprivate

---

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

• hps.h