Namespace for Alarm Notifications application. More...

Classes
class	AlarmConfiguration
	Configuration of the AlarmNotifications application. More...

class	AlarmServerConnector
	Connect to a CSS Alarm Server. More...

class	AlarmStatusEntry
	Entry in the AlarmServerConnector statusmap. More...

class	Beedo
	Opto-acoustic alarm engine. More...

class	CMSClient
	C++ Messaging Service client. More...

class	ConfigScreen

class	Daemon
	Alarm Notification daemon. More...

class	DesktopAlarmWidget
	Abstract base class for desktop alarm widgets. More...

class	DesktopAlarmWidgetKde4
	Desktop widget featuring an item in the KDE4 notification area. More...

class	DesktopAlarmWidgetQt
	Desktop widget featuring a Qt system tray icon. More...

class	EMailSender
	Send alarm notifications via e-mail. More...

class	FlashLight
	Controller for USB relais of red alarm flash light. More...

Functions
std::ostream &	operator<< (std::ostream &os, const AlarmNotifications::AlarmStatusEntry &ase)
	Stream output operator for AlarmStatusEntry. More...

void	ExceptionHandler (std::exception &e, std::string location, const bool quit=false) noexcept
	Generic exception handler for known exceptions. More...

void	ExceptionHandler (std::string location, const bool quit=false) noexcept
	Generic exception handler for unknown exceptions. More...

void	InitializeXThreads ()
	Call XInitThreads() from Xlib. More...

Detailed Description

Namespace for Alarm Notifications application.

All classes written as part of the Alarm Notifications program are put into this namespace to tell them apart from the classes provided by other libraries such as QtSmtpClient or Apache ActiveMQ.

Everything in this namespace has been authored by the Institut für Experimentalphysik I of Ruhr-Universität Bochum.

Function Documentation

void AlarmNotifications::ExceptionHandler	(	std::exception &	e,
		std::string	location,
		const bool	quit = `false`
	)

noexcept

Generic exception handler for known exceptions.

This function will display an error message containing the type name and the message of the exception and optionally quit the application gracefully.

Parameters

e	The standard exception object
location	A string explaining the point where the exception occured
quit	A flag whether to exit the application or not, default is false

Returns: Nothing. If quit is set to true, this function does not return.

Definition at line 41 of file exceptionhandler.cpp.

void AlarmNotifications::ExceptionHandler	(	std::string	location,
		const bool	quit = `false`
	)

noexcept

Generic exception handler for unknown exceptions.

This function will display an error message explaining that no exception object is available and optionally quit the application gracefully.

Parameters

location	A string explaining the point where the exception occured
quit	A flag whether to exit the application or not, default is false

Returns: Nothing. If quit is set to true, this function does not return.

Definition at line 66 of file exceptionhandler.cpp.

void AlarmNotifications::InitializeXThreads ( )

Call XInitThreads() from Xlib.

This basically invokes the plain X11 API call XInitThreads() and throws an exception if the initialization failed.

Returns: Nothing

Exceptions

std::logic_error The X11 API returned 0.

Definition at line 45 of file x11compat.cpp.

std::ostream & AlarmNotifications::operator<<	(	std::ostream &	os,
		const AlarmNotifications::AlarmStatusEntry &	ase
	)

Stream output operator for AlarmStatusEntry.

Print an instance of AlarmStatusEntry to any output stream, e.g. to stdout for debug purposes.

Parameters

os	Standard output stream
ase	An instance of AlarmStatusEntry

Returns: The supplied output stream

Definition at line 176 of file alarmstatusentry.cpp.

Classes

Functions

Detailed Description

Function Documentation