FDO API Reference Feature Data Objects

FeatureContext.h

Go to the documentation of this file.
00001 #ifndef FDO_XML_FEATURECONTEXT_H
00002 #define FDO_XML_FEATURECONTEXT_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 <Common/Xml/SaxContext.h>
00027 
00028 class FdoXmlFeaturePropertyReader;
00029 
00030 /// \brief
00031 /// FdoXmlFeatureContext provides contextual information to the FdoXmlFeatureHandler 
00032 /// callback implementations when an XML document parse is in progress. This class 
00033 /// provides very rudimentary functionality such as error reporting and access to the 
00034 /// FdoXmlFeaturePropertyReader doing the parse. Applications can pass extra information
00035 /// by sub-classing from this class.
00036 class FdoXmlFeatureContext : public FdoXmlSaxContext
00037 {
00038 public:
00039     /// \brief
00040     /// Constructs an XML  feature context
00041     /// 
00042     /// \param reader 
00043     /// Input the FdoXmlFeaturePropertyReader that is parsing the XML document.
00044     /// 
00045     /// \return
00046     /// Returns FdoXmlFeatureContext
00047     /// 
00048     FDO_API static FdoXmlFeatureContext* Create(FdoXmlFeaturePropertyReader* reader);
00049 
00050     /// \brief
00051     /// Gets the FdoXmlFeaturePropertyReader that is parsing the XML document.
00052     /// 
00053     /// \return
00054     /// Returns FdoXmlFeaturePropertyReader
00055     /// 
00056     FDO_API virtual FdoXmlFeaturePropertyReader* GetFeaturePropertyReader();
00057 
00058 protected:
00059     FdoXmlFeatureContext(FdoXmlFeaturePropertyReader* reader);
00060     virtual ~FdoXmlFeatureContext();
00061 };
00062 
00063 /// \brief
00064 /// FdoXmlFeatureContextP is a FdoPtr on FdoXmlFeatureContext, provided for convenience.
00065 typedef FdoPtr<FdoXmlFeatureContext> FdoXmlFeatureContextP;
00066 
00067 #endif
00068 
00069 

Comments or suggestions? Send us feedback.