StUCMException.h

/*
 * @file StUCMException.h
 * @author Stephen Tramer
 *
 * @(#)cpp/api:$Id: StUCMException.h,v 1.2 2010/03/30 20:05:36 fine Exp $
 *
 * StUCMException is the generic exception thrown by UCM; it serves
 * as the base class for the more specific TxDataException and TxModuleException
 * classes.  
 */
 
#ifndef _ST_UCM_EXCEPTION_H_
#define _ST_UCM_EXCEPTION_H_

#include <string>

class StUCMException {
 public:
  enum Severity
    {
      WARN,
      ERROR,
      FATAL
    };

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

  virtual ~StUCMException();

  virtual std::string getDescription() const;

  virtual Severity getSeverity() const;

 protected:
  StUCMException(Severity severity = ERROR);

  void setDescription(const std::string& description);

 private:
  std::string description_;
  Severity severity_;
};

#endif