Merge of itasc branch. Project files, scons and cmake should be working. Makefile...
[blender.git] / intern / itasc / kdl / utilities / error.h
1 /***************************************************************************
2   tag: Erwin Aertbelien  Mon Jan 10 16:38:38 CET 2005  error.h 
3
4                         error.h -  description
5                            -------------------
6     begin                : Mon January 10 2005
7     copyright            : (C) 2005 Erwin Aertbelien
8     email                : erwin.aertbelien@mech.kuleuven.ac.be
9  
10  ***************************************************************************
11  *   This library is free software; you can redistribute it and/or         *
12  *   modify it under the terms of the GNU Lesser General Public            *
13  *   License as published by the Free Software Foundation; either          *
14  *   version 2.1 of the License, or (at your option) any later version.    *
15  *                                                                         *
16  *   This library is distributed in the hope that it will be useful,       *
17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
19  *   Lesser General Public License for more details.                       *
20  *                                                                         *
21  *   You should have received a copy of the GNU Lesser General Public      *
22  *   License along with this library; if not, write to the Free Software   *
23  *   Foundation, Inc., 59 Temple Place,                                    *
24  *   Suite 330, Boston, MA  02111-1307  USA                                *
25  *                                                                         *
26  ***************************************************************************/
27  
28  
29 /*****************************************************************************
30  * \file  
31  *               Defines the exception classes that can be thrown
32  *  \author 
33  *      Erwin Aertbelien, Div. PMA, Dep. of Mech. Eng., K.U.Leuven
34  *
35  *  \version 
36  *              ORO_Geometry V0.2
37  *
38  *      \par History
39  *              - $log$
40  *
41  *      \par Release
42  *              $Id: error.h 19905 2009-04-23 13:29:54Z ben2610 $
43  *              $Name:  $ 
44  ****************************************************************************/
45 #ifndef ERROR_H_84822 // to make it unique, a random number
46 #define ERROR_H_84822
47
48 #include "utility.h"
49 #include <string>
50
51 namespace KDL {
52
53 /** 
54  *  Base class for errors generated by ORO_Geometry 
55  */
56 class Error {
57 public:
58     /** Returns a description string describing the error.
59      *  the returned pointer only garanteed to exists as long as 
60      * the Error object exists.
61      */
62         virtual ~Error() {}
63     virtual const char* Description() const {return "Unspecified Error\n";}
64
65     virtual int GetType() const {return 0;}
66 };
67
68
69 class Error_IO : public Error {
70         std::string msg;
71         int typenr;
72 public:
73         Error_IO(const std::string& _msg="Unspecified I/O Error",int typenr=0):msg(_msg) {}
74     virtual const char* Description() const {return msg.c_str();}
75     virtual int GetType() const {return typenr;}
76 };
77 class Error_BasicIO : public Error_IO {};
78 class Error_BasicIO_File : public Error_BasicIO {
79 public:
80     virtual const char* Description() const {return "Error while reading stream";}
81     virtual int GetType() const {return 1;}
82 };
83 class Error_BasicIO_Exp_Delim : public Error_BasicIO {
84 public:
85     virtual const char* Description() const {return "Expected Delimiter not encountered";}
86     virtual int GetType() const {return 2;}
87 };
88 class Error_BasicIO_Not_A_Space : public Error_BasicIO {
89 public:
90     virtual const char* Description() const {return "Expected space,tab or newline not encountered";}
91     virtual int GetType() const {return 3;}
92 };
93 class Error_BasicIO_Unexpected : public Error_BasicIO {
94 public:
95     virtual const char* Description() const {return "Unexpected character";}
96     virtual int GetType() const {return 4;}
97 };
98
99 class Error_BasicIO_ToBig : public Error_BasicIO {
100 public:
101     virtual const char* Description() const {return "Word that is read out of stream is bigger than maxsize";}
102     virtual int GetType() const {return 5;}
103 };
104
105 class Error_BasicIO_Not_Opened : public Error_BasicIO {
106 public:
107     virtual const char* Description() const {return "File cannot be opened";}
108     virtual int GetType() const {return 6;}
109 };
110 class Error_FrameIO : public Error_IO {};
111 class Error_Frame_Vector_Unexpected_id : public Error_FrameIO {
112 public:
113     virtual const char* Description() const {return "Unexpected identifier, expecting a vector (explicit or ZERO)";}
114     virtual int GetType() const {return 101;}
115 };
116 class Error_Frame_Frame_Unexpected_id : public Error_FrameIO {
117 public:
118     virtual const char* Description() const {return "Unexpected identifier, expecting a Frame (explicit or DH)";}
119     virtual int GetType() const {return 102;}
120 };
121 class Error_Frame_Rotation_Unexpected_id : public Error_FrameIO {
122 public:
123     virtual const char* Description() const {return "Unexpected identifier, expecting a Rotation (explicit or EULERZYX, EULERZYZ, RPY,ROT,IDENTITY)";}
124     virtual int GetType() const {return 103;}
125 };
126 class Error_ChainIO : public Error {};
127 class Error_Chain_Unexpected_id : public Error_ChainIO {
128 public:
129     virtual const char* Description() const {return "Unexpected identifier, expecting TRANS or ROT";}
130     virtual int GetType() const {return 201;}
131 };
132 //! Error_Redundancy indicates an error that occured during solving for redundancy.
133 class Error_RedundancyIO:public Error_IO  {};
134 class Error_Redundancy_Illegal_Resolutiontype : public Error_RedundancyIO {
135 public:
136     virtual const char* Description() const {return "Illegal Resolutiontype is used in I/O with ResolutionTask";}
137     virtual int GetType() const {return 301;}
138 };
139 class Error_Redundancy:public Error  {};
140 class Error_Redundancy_Unavoidable : public Error_Redundancy {
141 public:
142     virtual const char* Description() const {return "Joint limits cannot be avoided";}
143     virtual int GetType() const {return 1002;}
144 };
145 class  Error_Redundancy_Low_Manip: public Error_Redundancy {
146 public:
147     virtual const char* Description() const {return "Manipulability is very low";}
148     virtual int GetType() const {return 1003;}
149 };
150 class Error_MotionIO : public Error {};
151 class Error_MotionIO_Unexpected_MotProf : public Error_MotionIO {
152 public:
153     virtual const char* Description() const { return "Wrong keyword while reading motion profile";}
154     virtual int GetType() const {return 2001;}
155 };
156 class Error_MotionIO_Unexpected_Traj : public Error_MotionIO {
157 public:
158     virtual const char* Description() const { return "Trajectory type keyword not known";}
159     virtual int GetType() const {return 2002;}
160 };
161
162 class Error_MotionPlanning : public Error {};
163
164 class Error_MotionPlanning_Circle_ToSmall : public Error_MotionPlanning {
165 public:
166     virtual const char* Description() const { return "Circle : radius is to small";}
167     virtual int GetType() const {return 3001;}
168 };
169
170 class Error_MotionPlanning_Circle_No_Plane : public Error_MotionPlanning {
171 public:
172     virtual const char* Description() const { return "Circle : Plane for motion is not properly defined";}
173     virtual int GetType() const {return 3002;}
174 };
175
176 class Error_MotionPlanning_Incompatible: public Error_MotionPlanning {
177 public:
178     virtual const char* Description() const { return "Acceleration of a rectangular velocityprofile cannot be used";}
179     virtual int GetType() const {return 3003;}
180 };
181
182 class Error_MotionPlanning_Not_Feasible: public Error_MotionPlanning {
183 public:
184     virtual const char* Description() const { return "Motion Profile with requested parameters is not feasible";}
185     virtual int GetType() const {return 3004;}
186 };
187
188 class Error_MotionPlanning_Not_Applicable: public Error_MotionPlanning {
189 public:
190     virtual const char* Description() const { return "Method is not applicable for this derived object";}
191     virtual int GetType() const {return 3004;}
192 };
193 //! Abstract subclass of all errors that can be thrown by Adaptive_Integrator
194 class Error_Integrator : public Error {};
195
196 //! Error_Stepsize_Underflow is thrown if the stepsize becomes to small
197 class Error_Stepsize_Underflow  : public Error_Integrator {
198 public: 
199     virtual const char* Description() const { return "Stepsize Underflow";}
200     virtual int GetType() const {return 4001;}
201 };
202
203 //! Error_To_Many_Steps is thrown if the number of steps needed to
204 //! integrate to the desired accuracy becomes to big.
205 class Error_To_Many_Steps : public Error_Integrator {
206 public:
207     virtual const char* Description() const { return "To many steps"; }
208     virtual int GetType() const {return 4002;}
209 };
210
211 //! Error_Stepsize_To_Small is thrown if the stepsize becomes to small  
212 class Error_Stepsize_To_Small : public Error_Integrator {
213 public:
214     virtual const char* Description() const { return "Stepsize to small"; }
215     virtual int GetType() const {return 4003;}
216 };
217
218 class Error_Criterium : public Error {};
219
220 class Error_Criterium_Unexpected_id: public Error_Criterium {
221 public:
222     virtual const char* Description() const { return "Unexpected identifier while reading a criterium";   }
223     virtual int GetType() const {return 5001;}
224 };
225
226 class Error_Limits : public Error {};
227
228 class Error_Limits_Unexpected_id: public Error_Limits {
229 public:
230     virtual const char* Description() const { return "Unexpected identifier while reading a jointlimits"; }
231     virtual int GetType() const {return 6001;}
232 };
233
234
235 class Error_Not_Implemented: public Error {
236 public:
237     virtual const char* Description() const { return "The requested object/method/function is not implemented"; }
238     virtual int GetType() const {return 7000;}
239 };
240
241
242
243 }
244
245 #endif