Open Inventor Reference
SoMemoryError.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (C) 2000 Silicon Graphics, Inc. All Rights Reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * Further, this software is distributed without any warranty that it is
16  * free of the rightful claim of any third person regarding infringement
17  * or the like. Any license provided herein, whether implied or
18  * otherwise, applies only to this software file. Patent licenses, if
19  * any, provided herein do not apply to combinations of this program with
20  * other software, or any other product whatsoever.
21  *
22  * You should have received a copy of the GNU Lesser General Public
23  * License along with this library; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25  *
26  * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
27  * Mountain View, CA 94043, or:
28  *
29  * http://www.sgi.com
30  *
31  * For further information regarding this notice, see:
32  *
33  * http://oss.sgi.com/projects/GenInfo/NoticeExplan/
34  *
35  */
36 
37 
38 /*
39  * Copyright (C) 1990,91 Silicon Graphics, Inc.
40  *
41  _______________________________________________________________________
42  ______________ S I L I C O N G R A P H I C S I N C . ____________
43  |
44  | $Revision: 1.2 $
45  |
46  | Description:
47  | This file defines the SoMemoryError class.
48  |
49  | Classes:
50  | SoMemoryError
51  |
52  | Author(s) : Paul S. Strauss
53  |
54  ______________ S I L I C O N G R A P H I C S I N C . ____________
55  _______________________________________________________________________
56  */
57 
58 #ifndef _SO_MEMORY_ERROR
59 #define _SO_MEMORY_ERROR
60 
62 
63 
66 
77 
79 
80  public:
81 
83  static void setHandlerCallback(SoErrorCB *cb, void *data)
84  { handlerCB = cb; cbData = data; }
86  static SoErrorCB * getHandlerCallback() { return handlerCB; }
88  static void * getHandlerData() { return cbData; }
89 
91  static SoType getClassTypeId() { return classTypeId; }
92 
94  virtual SoType getTypeId() const;
95 
96  SoEXTENDER public:
98  static void post(const char *whatWasAllocated);
99 
100  SoINTERNAL public:
102  static void initClass();
103 
104  protected:
106  virtual SoErrorCB * getHandler(void *&data) const;
107 
108  virtual ~SoMemoryError() {}
109 
110  private:
111  static SoType classTypeId;
112  static SoErrorCB *handlerCB;
113  static void *cbData;
114 };
115 
116 #endif /* _SO_MEMORY_ERROR */
#define SoEXTENDER
Provide inline template functions for abs, swap, min, max, and clamp.
Definition: SbBasic.h:154
#define SoINTERNAL
Definition: SbBasic.h:155
#define INVENTOR_API
Disable some annoying warnings on MSVC 6.
Definition: SbSystem.h:81
void INVENTOR_API SoErrorCB(const SoError *error, void *data)
Error handling callbacks are of this type:
Definition: SoError.h:74
Error handling base class.
Definition: SoError.h:117
Memory error handling.
Definition: SoMemoryError.h:78
virtual SoType getTypeId() const
Returns type identifier for error instance.
static void setHandlerCallback(SoErrorCB *cb, void *data)
Sets/returns handler callback for SoMemoryError class.
Definition: SoMemoryError.h:83
static SoType getClassTypeId()
Returns type identifier for SoMemoryError class.
Definition: SoMemoryError.h:91
static void * getHandlerData()
Sets/returns handler callback for SoMemoryError class.
Definition: SoMemoryError.h:88
static void initClass()
Initializes SoMemoryError class.
static SoErrorCB * getHandlerCallback()
Sets/returns handler callback for SoMemoryError class.
Definition: SoMemoryError.h:86
static void post(const char *whatWasAllocated)
Posts an error.
virtual ~SoMemoryError()
virtual SoErrorCB * getHandler(void *&data) const
Returns handler callback (and data) to use for a given instance.
SoType has no virtual functions to keep it small...
Definition: SoType.h:103