FDO API Reference Feature Data Objects

AutogenerationException.h

Go to the documentation of this file.
00001 #ifndef _AUTOGENERATIONEXCEPTION_H_
00002 #define _AUTOGENERATIONEXCEPTION_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 #include <Fdo/Schema/SchemaException.h>
00027 
00028 /// \brief
00029 /// The FdoAutogenerationException class is the exception type thrown
00030 /// when autogeneration of a data property cannot be honored, either because
00031 /// the data type is not supported for autogeneration, too many properties
00032 /// were marked as autogenerated, the autogeneration feature is not supported,
00033 /// or possibly because of provider-specific errors.
00034 class FdoAutogenerationException : public FdoSchemaException
00035 {
00036 protected:
00037 /// \cond DOXYGEN-IGNORE
00038     /// Constructs a default instance of an FdoAutogenerationException.
00039     FdoAutogenerationException();
00040 
00041     /// Constructs an instance of an FdoAutogenerationException using the specified
00042     /// arguments.
00043     FdoAutogenerationException(FdoString* message);
00044 
00045     /// Constructs an instance of an FdoAutogenerationException using the specified
00046     /// arguments.
00047     FdoAutogenerationException(FdoString* message, FdoException* cause);
00048 
00049     virtual ~FdoAutogenerationException();
00050 
00051     virtual void Dispose();
00052 /// \endcond
00053 
00054 public:
00055     /// \brief
00056     /// Constructs a default instance of an FdoAutogenerationException.
00057     /// 
00058     /// \return
00059     /// Returns FdoAutogenerationException
00060     /// 
00061     FDO_API static FdoAutogenerationException* Create();
00062 
00063     /// \brief
00064     /// Constructs an instance of an FdoAutogenerationException using the specified arguments.
00065     /// 
00066     /// \param message 
00067     /// Input message text
00068     /// 
00069     /// \return
00070     /// Returns FdoAutogenerationException
00071     /// 
00072     FDO_API static FdoAutogenerationException* Create(FdoString* message);
00073 
00074     /// \brief
00075     /// Constructs an instance of an FdoAutogenerationException using the specified arguments.
00076     /// 
00077     /// \param name 
00078     /// Input name text
00079     /// \param cause 
00080     /// Input cause of exception
00081     /// 
00082     /// \return
00083     /// Returns FdoAutogenerationException
00084     /// 
00085     FDO_API static FdoAutogenerationException* Create(FdoString* name, FdoException* cause);
00086 };
00087 
00088 /// \brief
00089 /// FdoSchemaExceptionP is a FdoPtr on FdoAutogenerationException, provided for convenience.
00090 typedef FdoPtr<FdoAutogenerationException> FdoAutogenerationExceptionP;
00091 
00092 #endif
00093 
00094 

Comments or suggestions? Send us feedback.