---

nullbuffer.hpp

Go to the documentation of this file.

#if !defined(_NULLBUFFER_HPP)
#define _NULLBUFFER_HPP
//============================================================================= 
//
// XDFLengine library
//
//----------------------------------------------------------------------------- 
//  NULLBUFFER.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/xmlstreambuffer.hpp"

BEGIN_XDFLENGINE_NS

//============================================================================= 
//  CLASS NULLBUFFER
//----------------------------------------------------------------------------- 
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
class XDFLENGINE_EXPORT NullBuffer: public XMLStreamBuffer 
{

    public: //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    // CONTRUCTOR & DESTRUCTOR
    
        //_____________________________________________________________________
        //  NULLBUFFER
        //---------------------------------------------------------------------
        //_____________________________________________________________________ 
        NullBuffer  ();

        //_____________________________________________________________________
        //  NULLBUFFER
        //---------------------------------------------------------------------
        //_____________________________________________________________________ 
        NullBuffer ( const char* p_cFileName, bool p_boolReadOnly = false);
        
        //_____________________________________________________________________
        //  ~NULLBUFFER
        //---------------------------------------------------------------------
        //_____________________________________________________________________ 
        ~NullBuffer ();


    // STREAM OPERATORS

        //_____________________________________________________________________
        //  OPERATOR <<
        //---------------------------------------------------------------------
        //_____________________________________________________________________         
        XMLStreamBuffer & operator<<    ( const char* p_cData);

        //_____________________________________________________________________
        //  OPERATOR <<
        //---------------------------------------------------------------------
        //_____________________________________________________________________ 
        XMLStreamBuffer & operator<<    ( XMLStreamBuffer& p_pXMLStreamBuffer);

        //_____________________________________________________________________
        //  OPERATOR >>
        //---------------------------------------------------------------------
        //_____________________________________________________________________         
        XMLStreamBuffer & operator>>    ( XMLStreamBuffer& p_pXMLStreamBuffer);

    // DATA

        //_____________________________________________________________________
        //  OPERATOR <<
        //---------------------------------------------------------------------
        //_____________________________________________________________________         
        void write ( const void* p_bData, int p_intSize);

        //_____________________________________________________________________
        //  FLUSH 
        //---------------------------------------------------------------------
        //_____________________________________________________________________ 
        void flush ();

        //_____________________________________________________________________
        //  DATA
        //---------------------------------------------------------------------
        //_____________________________________________________________________ 
        void* data ();

        //_____________________________________________________________________
        //  LENGTH
        //---------------------------------------------------------------------
        //_____________________________________________________________________ 
        int length ();

        //_____________________________________________________________________
        //  GETINPUTSOURCE
        //---------------------------------------------------------------------
        //_____________________________________________________________________ 
        InputSource* getInputSource ();

        //_____________________________________________________________________
        //  GETNAME
        //---------------------------------------------------------------------
        //_____________________________________________________________________ 
        const char*  getName ();

        //_____________________________________________________________________
        //  SLEEP
        //---------------------------------------------------------------------
        //_____________________________________________________________________ 
        void sleep ();

};
//=============================================================================

END_XDFLENGINE_NS

#endif

---