← Back to branch summary

~ubuntu-branches/ubuntu/warty/aqsis/warty

« back to all changes in this revision

Viewing changes to libaqsistypes/exception.h

  • Committer: Bazaar Package Importer
  • Author(s): LaMont Jones
  • Date: 2004-08-24 07:25:04 UTC
  • Revision ID: james.westby@ubuntu.com-20040824072504-zf993vnevvisdsvb
Tags: upstream-0.9.1
Import upstream version 0.9.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
libaqsistypes/exception.h
 
1
// Aqsis
 
2
// Copyright � 1997 - 2001, Paul C. Gregory
 
3
//
 
4
// Contact: pgregory@aqsis.com
 
5
//
 
6
// This library is free software; you can redistribute it and/or
 
7
// modify it under the terms of the GNU General Public
 
8
// License as published by the Free Software Foundation; either
 
9
// version 2 of the License, or (at your option) any later version.
 
10
//
 
11
// This library is distributed in the hope that it will be useful,
 
12
// but WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
14
// General Public License for more details.
 
15
//
 
16
// You should have received a copy of the GNU General Public
 
17
// License along with this library; if not, write to the Free Software
 
18
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
19
 
 
20
 
 
21
/** \file
 
22
                \brief Declares the XqException base class thrown during exceptions.
 
23
                \author Paul C. Gregory (pgregory@aqsis.com)
 
24
*/
 
25
 
 
26
//? Is exception.h included already?
 
27
#ifndef EXCEPTION_H_INCLUDED 
 
28
//{
 
29
#define EXCEPTION_H_INCLUDED 1
 
30
 
 
31
#include        "aqsis.h"
 
32
 
 
33
#include        "sstring.h"
 
34
 
 
35
START_NAMESPACE( Aqsis )
 
36
 
 
37
//-----------------------------------------------------------------------
 
38
/** General message based exception.  specific exceptions are derived from this.
 
39
 */
 
40
 
 
41
class XqException
 
42
{
 
43
public:
 
44
    /** Default constructor.
 
45
     * \param pcharReason Pointer to a string associated with the error which caused the exception.
 
46
     */
 
47
    XqException( const char* pcharReason = 0 ) :
 
48
            m_strReason( pcharReason )
 
49
    {}
 
50
    virtual     ~XqException()
 
51
    {}
 
52
 
 
53
    /** Get a reference to the error message.
 
54
     * \return a constant string reference.
 
55
     */
 
56
    const CqString&     strReason()
 
57
    {
 
58
        return ( m_strReason );
 
59
    }
 
60
 
 
61
private:
 
62
    CqString    m_strReason;    ///< The message associated with this exception.
 
63
}
 
64
;
 
65
 
 
66
//-----------------------------------------------------------------------
 
67
 
 
68
END_NAMESPACE( Aqsis )
 
69
 
 
70
 
 
71
#endif // EXCEPTION_H_INCLUDED