StUCMException Class Reference

#include <StUCMException.h>

Inheritance diagram for StUCMException:

List of all members.

Public Types
enum	Severity { WARN, ERROR, FATAL }
Public Member Functions
	StUCMException (const std::string &description, Severity severity=ERROR)
virtual	~StUCMException ()
virtual std::string	getDescription () const
virtual Severity	getSeverity () const
Protected Member Functions
	StUCMException (Severity severity=ERROR)
void	setDescription (const std::string &description)

---

Detailed Description

The base class for all exceptions thrown by the UCM library.

Definition at line 20 of file StUCMException.h.

---

Member Enumeration Documentation

enum StUCMException::Severity

Represents the available levels of exception severity.

Definition at line 25 of file StUCMException.h.

---

Constructor & Destructor Documentation

StUCMException::StUCMException	(	const std::string &	description,
		Severity	severity = ERROR
	)

Constructor: Provide description of the error, and optionally a severity.

Parameters:

	descrption	The error message for the exception.
	severity	The severity of the exception. Optional, defaults to ERROR.

Definition at line 14 of file StUCMException.cxx.

StUCMException::~StUCMException

(

)

[virtual]

Destructor: No-op

Definition at line 26 of file StUCMException.cxx.

---

Member Function Documentation

std::string StUCMException::getDescription

(

)

const [virtual]

Retrieve the error message.

Definition at line 31 of file StUCMException.cxx.

StUCMException::Severity StUCMException::getSeverity

(

)

const [virtual]

Retrieve the exception severity.

Definition at line 38 of file StUCMException.cxx.

---

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

• StStarLogger/logging/StUCMException.h
• StStarLogger/logging/StUCMException.cxx