FDO API Reference Feature Data Objects

SpatialContextMismatchException.h

Go to the documentation of this file.
00001 #ifndef _SPATIALCONTEXTMISMATCHEXCEPTION_H_
00002 #define _SPATIALCONTEXTMISMATCHEXCEPTION_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 FdoSpatialContextMismatchException class is the exception type thrown from classes 
00030 /// editing the datastore. It derives from a language level exception class that is
00031 /// environment-specific. This exception is thrown whenever a command operates on a geometry 
00032 /// whose spatial context does not match the active spatial context.
00033 /// The message should always mention which spatial contexts were mismatched.
00034 class FdoSpatialContextMismatchException : public FdoException
00035 {
00036 protected:
00037     /// Constructs a default instance of an FdoSpatialContextMismatchException.
00038     FDO_API FdoSpatialContextMismatchException();
00039 
00040     /// Constructs an instance of an FdoSpatialContextMismatchException using the specified
00041     /// arguments.
00042     FDO_API FdoSpatialContextMismatchException(FdoString* message);
00043 
00044     /// Constructs an instance of an FdoSpatialContextMismatchException using the specified
00045     /// arguments.
00046     FDO_API FdoSpatialContextMismatchException(FdoString* message, FdoException* cause);
00047 
00048     FDO_API virtual ~FdoSpatialContextMismatchException();
00049 
00050     FDO_API virtual void Dispose();
00051 
00052 public:
00053     /// \brief
00054     /// Constructs a default instance of an FdoSpatialContextMismatchException.
00055     /// 
00056     /// \return
00057     /// Returns FdoSpatialContextMismatchException
00058     /// 
00059     FDO_API static FdoSpatialContextMismatchException* Create();
00060 
00061     /// \brief
00062     /// Constructs an instance of an FdoSpatialContextMismatchException using the specified arguments.
00063     /// 
00064     /// \param message 
00065     /// Input message text
00066     /// 
00067     /// \return
00068     /// Returns FdoSpatialContextMismatchException
00069     /// 
00070     FDO_API static FdoSpatialContextMismatchException* Create(FdoString* message);
00071 
00072     /// \brief
00073     /// Constructs an instance of an FdoSpatialContextMismatchException using the specified arguments.
00074     /// 
00075     /// \param message 
00076     /// Input name text
00077     /// \param cause 
00078     /// Input cause of exception
00079     /// 
00080     /// \return
00081     /// Returns FdoSpatialContextMismatchException
00082     /// 
00083     FDO_API static FdoSpatialContextMismatchException* Create(FdoString* message, FdoException* cause);
00084 };
00085 
00086 /// \brief
00087 /// FdoSpatialContextMismatchExceptionP is a FdoPtr on FdoSpatialContextMismatchException, provided for convenience.
00088 typedef FdoPtr<FdoSpatialContextMismatchException> FdoSpatialContextMismatchExceptionP;
00089 
00090 #endif
00091 
00092 

Comments or suggestions? Send us feedback.