Coin: SoError.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoError.h
1#ifndef COIN_SOERROR_H
2#define COIN_SOERROR_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36#include <Inventor/SbBasic.h>
37#include <Inventor/SbString.h>
38#include <Inventor/C/errors/error.h>
39#include <Inventor/SoType.h>
40
41class SoBase;
42class SoNode;
43class SoPath;
44class SoEngine;
45
46typedef void SoErrorCB(const class SoError * error, void * data);
47typedef SoErrorCB * SoErrorCBPtr;
48
49
50 class COIN_DLL_API SoError {
51public:
52 SoError(void) { cc_error_init(&this->err); }
53 virtual ~SoError() { cc_error_clean(&this->err); }
54
55 static void setHandlerCallback(SoErrorCB * const func, void * const data);
56 static SoErrorCB * getHandlerCallback(void);
57 static void * getHandlerData(void);
58
59 const SbString & getDebugString(void) const;
60
61 static SoType getClassTypeId(void);
62 virtual SoType getTypeId(void) const;
63 SbBool isOfType(const SoType type) const;
64
65 static void post(const char * const format, ...);
66
67 static SbString getString(const SoNode * const node);
68 static SbString getString(const SoPath * const path);
69 static SbString getString(const SoEngine * const engine);
70
71 static void initClass(void);
72 static void initClasses(void);
73
74protected:
75 static void defaultHandlerCB(const SoError * error, void * userdata);
76 virtual SoErrorCBPtr getHandler(void * & data) const;
77
78 void setDebugString(const char * const str);
79 void appendToDebugString(const char * const str);
80
81 void handleError(void);
82
83private:
84 SoError(const cc_error * error);
85 static void generateBaseString(SbString & str, const SoBase * const base,
86 const char * const what);
87
88 static void callbackForwarder(const cc_error * err, void * data);
89
90 static SoType classTypeId;
91 static SoErrorCB * callback;
92 static void * callbackData;
93 SbString debugstring;
94
95 cc_error err;
96};
97
98#endif // !COIN_SOERROR_H
SbString
The SbString class is a string class with convenience functions for string operations.
Definition SbString.h:52
SoBase
The SoBase class is the top-level superclass for a number of class-hierarchies.
Definition SoBase.h:45
SoEngine
SoEngine is the base class for Coin engines.
Definition SoEngine.h:43
SoError
The SoError class is the base class for all the error handling classes.
Definition SoError.h:50
SoError::~SoError
virtual ~SoError()
Definition SoError.h:53
SoNode
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:56
SoPath
The SoPath class is a container class for traversal path descriptions.
Definition SoPath.h:52
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59
cc_error
Definition error.h:49