FDO API Reference Feature Data Objects

XmlException.h

Go to the documentation of this file.
00001 #ifndef FDO_XML_EXCEPTION_H_
00002 #define FDO_XML_EXCEPTION_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 <FdoCommon.h>
00027 
00028 /// \brief
00029 /// FdoXmlException is a root class for exception type thrown from the
00030 /// FDO XML package
00031 class FdoXmlException : public FdoException
00032 {
00033 protected:
00034 /// \cond DOXYGEN-IGNORE
00035     /// \brief
00036     ///  Constructs a default instance of an FdoXmlException.
00037     /// 
00038     FdoXmlException();
00039 
00040     /// \brief
00041     ///  Constructs an instance of an FdoXmlException using the specified
00042     /// arguments.
00043     /// 
00044     FdoXmlException(FdoString* message);
00045 
00046     /// \brief
00047     ///  Constructs an instance of an FdoXmlException using the specified
00048     /// arguments.
00049     /// 
00050     /// \param message 
00051     /// Input the error message
00052     /// \param cause 
00053     /// Input the cause of the error
00054     /// 
00055     /// \return
00056     /// Returns nothing
00057     /// 
00058     FdoXmlException(FdoString* message, FdoException* cause);
00059 
00060     virtual void Dispose();
00061 /// \endcond
00062 
00063 public:
00064     /// \brief
00065     /// Returns a default instance of an FdoXmlException.
00066     /// 
00067     /// \return
00068     /// Returns FdoXmlException object
00069     /// 
00070     FDO_API_COMMON static FdoXmlException* Create();
00071 
00072     /// \brief
00073     /// Returns an instance of an FdoXmlException using the specified arguments.
00074     /// 
00075     /// \param message 
00076     /// Input the error message
00077     /// 
00078     /// \return
00079     /// Returns the Exception object
00080     /// 
00081     FDO_API_COMMON static FdoXmlException* Create(FdoString* message);
00082 
00083     /// \brief
00084     /// Returns an instance of an FdoXmlException using the specified arguments.
00085     /// 
00086     /// \param message 
00087     /// Input the error message
00088     /// \param cause 
00089     /// Input the cause of the error
00090     /// 
00091     /// \return
00092     /// Returns FdoXmlException object
00093     /// 
00094     FDO_API_COMMON static FdoXmlException* Create(FdoString* message, FdoException* cause);
00095 
00096 };
00097 
00098 /// \brief
00099 /// FdoXmlExceptionP is a FdoPtr on FdoXmlException, provided for convenience.
00100 typedef FdoPtr<FdoXmlException> FdoXmlExceptionP;
00101 
00102 #endif
00103 
00104 

Comments or suggestions? Send us feedback.