BESInfo.h

Go to the documentation of this file.
00001 // BESInfo.h
00002 
00003 // This file is part of bes, A C++ back-end server implementation framework
00004 // for the OPeNDAP Data Access Protocol.
00005 
00006 // Copyright (c) 2004,2005 University Corporation for Atmospheric Research
00007 // Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
00008 //
00009 // This library is free software; you can redistribute it and/or
00010 // modify it under the terms of the GNU Lesser General Public
00011 // License as published by the Free Software Foundation; either
00012 // version 2.1 of the License, or (at your option) any later version.
00013 // 
00014 // This library is distributed in the hope that it will be useful,
00015 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00016 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00017 // Lesser General Public License for more details.
00018 // 
00019 // You should have received a copy of the GNU Lesser General Public
00020 // License along with this library; if not, write to the Free Software
00021 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00022 //
00023 // You can contact University Corporation for Atmospheric Research at
00024 // 3080 Center Green Drive, Boulder, CO 80301
00025  
00026 // (c) COPYRIGHT University Corporation for Atmostpheric Research 2004-2005
00027 // Please read the full copyright statement in the file COPYRIGHT_UCAR.
00028 //
00029 // Authors:
00030 //      pwest       Patrick West <pwest@ucar.edu>
00031 //      jgarcia     Jose Garcia <jgarcia@ucar.edu>
00032 
00033 #ifndef BESInfo_h_
00034 #define BESInfo_h_ 1
00035 
00036 #include <string>
00037 #include <ostream>
00038 #include <stack>
00039 #include <map>
00040 
00041 using std::string ;
00042 using std::ostream ;
00043 using std::stack ;
00044 using std::map ;
00045 
00046 #include "BESResponseObject.h"
00047 #include "BESDataHandlerInterface.h"
00048 #include "BESTransmitter.h"
00049 #include "BESException.h"
00050 
00068 class BESInfo :public BESResponseObject
00069 {
00070 protected:
00071     ostream             *_strm ;
00072     bool                _buffered ;
00073     bool                _response_started ;
00074 
00075     stack<string>       _tags ;
00076     string              _response_name ;
00077 
00078 public:
00079                         BESInfo( ) ;
00080                         BESInfo( const string &buffered_key ) ;
00081     virtual             ~BESInfo() ;
00082 
00083     virtual void        begin_response( const string &response_name ) ;
00084     virtual void        end_response( ) ;
00085 
00086     virtual void        add_tag( const string &tag_name,
00087                                  const string &tag_data,
00088                                  map<string,string> *attrs = 0 ) = 0 ;
00089     virtual void        begin_tag( const string &tag_name,
00090                                    map<string,string> *attrs = 0 ) ;
00091     virtual void        end_tag( const string &tag_name ) ;
00092 
00093     virtual void        add_data( const string &s ) ;
00094     virtual void        add_space( unsigned long num_spaces ) = 0 ;
00095     virtual void        add_break( unsigned long num_breaks ) = 0 ;
00096 
00097     virtual void        add_data_from_file( const string &key,
00098                                             const string &name ) ;
00099 
00100     virtual void        add_exception( BESException &e ) ;
00101 
00111     virtual void        transmit( BESTransmitter *transmitter,
00112                                   BESDataHandlerInterface &dhi ) = 0 ;
00113 
00114     virtual void        print( FILE *out ) ;
00115 
00120     virtual bool        set_buffered( bool buffered )
00121                         {
00122                             _buffered = buffered ;
00123                             return _buffered ;
00124                         }
00125 
00130     virtual bool        is_buffered() { return _buffered ; }
00131 
00136     virtual void                dump( ostream &strm ) const ;
00137 };
00138 
00139 #endif // BESInfo_h_
00140 

Generated on Wed Aug 29 03:14:16 2007 for OPeNDAP Back End Server (BES) by  doxygen 1.5.2