---

xmlstreamer.hpp

Go to the documentation of this file.

#if !defined(_XMLSTREAMER_HPP)
#define _XMLSTREAMER_HPP
//============================================================================= 
//
// XDFLengine library
//
//----------------------------------------------------------------------------- 
//  XMLSTREAMER.HPP
//----------------------------------------------------------------------------- 
//_____________________________________________________________________________
//
//  Copyright (C) 2003 Guillaume Baurand. All Rights Reserved.
//
//  This file is part of the XDFLengine project.
//
//  The XDFLengine is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation; either version 2 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,
//  USA.
//
//  For more information, 
//      contact  : guillaume@baurand.net 
//      or visit : http://xdflengine.sourceforge.net
//
//=============================================================================  

#   include "config/commonincs.hpp"
#   include "flow/xmlstreamconsumer.hpp"

BEGIN_XDFLENGINE_NS

class XMLStreamerFactory;
class XMLFlowContext;
typedef  VAarray< char*> StreamerParams;

//============================================================================= 
//  CLASS XMLStreamer
//----------------------------------------------------------------------------- 
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
class XDFLENGINE_EXPORT XMLStreamer : public XMLStreamConsumer
{

protected:

    const XMLStreamerFactory*   m_pParent;
    StreamerParams*             m_pParameters;
    XMLFlowContext*             m_pContext;
    XMLStreamConsumer*          m_pOutput;

public:

    // STATICS

        //_____________________________________________________________________
        //  GETPARAMVALUE
        //---------------------------------------------------------------------
        //_____________________________________________________________________
        static const char* getParamValue( StreamerParams* p_pParameters, const char* p_pszParamName, const char* p_pszParamDefault = 0);    

    // CONTRUCTOR & DESTRUCTOR
    
        //_____________________________________________________________________
        //  XMLSTREAMER
        //---------------------------------------------------------------------
                //_____________________________________________________________________
        XMLStreamer( const XMLStreamerFactory* p_pParent, StreamerParams* p_pParameters, XMLFlowContext* p_pContext, XMLStreamConsumer* p_pOutput);

        //_____________________________________________________________________
        //  XMLSTREAMER
        //---------------------------------------------------------------------
                //_____________________________________________________________________
        virtual ~XMLStreamer();

    // STREAM

        //_____________________________________________________________________
        //  INITSTREAM
        //---------------------------------------------------------------------
                //_____________________________________________________________________
        virtual bool initStream();

        //_____________________________________________________________________
        //  WRITEDATA
        //---------------------------------------------------------------------
                //_____________________________________________________________________
        virtual void writeData( const char* p_pszData, unsigned int p_uiDataLen);

        //_____________________________________________________________________
        //  COMMITSTREAM
        //---------------------------------------------------------------------
                //_____________________________________________________________________
        virtual bool commitStream( bool p_fFinal=false);
};
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//=============================================================================

END_XDFLENGINE_NS

#endif

---