FDO API Reference Feature Data Objects

FilterException.h

Go to the documentation of this file.
00001 #ifndef _FILTEREXCEPTION_H_
00002 #define _FILTEREXCEPTION_H_
00003 // 
00004 
00005 //
00006 // Copyright (C) 2004-2006  Autodesk, Inc.
00007 // 
00008 // This library is free software; you can redistribute it and/or
00009 // modify it under the terms of version 2.1 of the GNU Lesser
00010 // General Public License as published by the Free Software Foundation.
00011 // 
00012 // This library is distributed in the hope that it will be useful,
00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015 // Lesser General Public License for more details.
00016 // 
00017 // You should have received a copy of the GNU Lesser General Public
00018 // License along with this library; if not, write to the Free Software
00019 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00020 //
00021 
00022 #ifdef _WIN32
00023 #pragma once
00024 #endif
00025 
00026 #include <FdoStd.h>
00027 
00028 /// \brief
00029 /// The FdoFilterException class is the exception type thrown from classes in the Filter
00030 /// package. It derives from a language level exception class that is
00031 /// environment-specific.
00032 class FdoFilterException : public FdoException
00033 {
00034 protected:
00035 /// \cond DOXYGEN-IGNORE
00036     /// Constructs a default instance of an FdoFilterException.
00037     FdoFilterException();
00038 
00039     /// Constructs an instance of an FdoFilterException using the specified
00040     /// arguments.
00041     FdoFilterException(FdoString* message);
00042 
00043     /// Constructs an instance of an FdoFilterException using the specified
00044     /// arguments.
00045     FdoFilterException(FdoString* message, FdoException* cause);
00046 
00047     virtual ~FdoFilterException();
00048 
00049     virtual void Dispose();
00050 /// \endcond
00051 
00052 public:
00053     /// \brief
00054     /// Constructs a default instance of an FdoFilterException.
00055     /// 
00056     /// \return
00057     /// Returns FdoFilterException
00058     /// 
00059     FDO_API static FdoFilterException* Create();
00060 
00061     /// \brief
00062     /// Constructs an instance of an FdoFilterException using the specified arguments.
00063     /// 
00064     /// \param message 
00065     /// Input message text
00066     /// 
00067     /// \return
00068     /// Returns FdoFilterException
00069     /// 
00070     FDO_API static FdoFilterException* Create(FdoString* message);
00071 
00072     /// \brief
00073     /// Constructs an instance of an FdoFilterException using the specified arguments.
00074     /// 
00075     /// \param message 
00076     /// Input message text
00077     /// \param cause 
00078     /// Input cause of exception
00079     /// 
00080     /// \return
00081     /// Returns FdoFilterException
00082     /// 
00083     FDO_API static FdoFilterException* Create(FdoString* message, FdoException* cause);
00084 };
00085 #endif
00086 
00087 

Comments or suggestions? Send us feedback.