FDO API Reference Feature Data Objects

SchemaException.h

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

Comments or suggestions? Send us feedback.