BESDataHandlerInterface.h

Go to the documentation of this file.
00001 // BESDataHandlerInterface.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 Atmospheric 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 BESDataHandlerInterface_h_
00034 #define BESDataHandlerInterface_h_ 1
00035 
00036 #include <string>
00037 #include <list>
00038 #include <map>
00039 #include <iostream>
00040 
00041 using std::string ;
00042 using std::list ;
00043 using std::map ;
00044 using std::ostream ;
00045 
00046 class BESResponseHandler ;
00047 class BESInfo ;
00048 
00049 #include "BESContainer.h"
00050 #include "BESInternalError.h"
00051 
00058 typedef struct _BESDataHandlerInterface
00059 {
00060 private:
00061     ostream *output_stream ;
00062 public:
00063     _BESDataHandlerInterface()
00064         : output_stream( 0 ),
00065           response_handler( 0 ),
00066           container( 0 ),
00067           error_info( 0 ) {}
00068 
00069 
00070     void set_output_stream( ostream *strm )
00071     {
00072         if( output_stream )
00073         {
00074             string err = "output stream has already been set" ;
00075             throw BESInternalError( err, __FILE__, __LINE__ ) ;
00076         }
00077         output_stream = strm ;
00078     }
00079     ostream &get_output_stream()
00080     {
00081         if( !output_stream )
00082             throw BESInternalError( "output stream has not yet been set, cannot use", __FILE__, __LINE__ ) ;
00083         return *output_stream ;
00084     }
00085 
00086     BESResponseHandler *response_handler ;
00087 
00088     list<BESContainer *> containers ;
00089     list<BESContainer *>::iterator containers_iterator ;
00090 
00093     BESContainer *container ;
00094 
00097     void first_container()
00098     {
00099         containers_iterator = containers.begin();
00100         if( containers_iterator != containers.end() )
00101             container = (*containers_iterator) ;
00102         else
00103             container = NULL ;
00104     }
00105 
00108     void next_container()
00109     {
00110         containers_iterator++ ;
00111         if( containers_iterator != containers.end() )
00112             container = (*containers_iterator) ;
00113         else
00114             container = NULL ;
00115     }
00116 
00119     string action ;
00120     string action_name ;
00121 
00124     string transmit_protocol ;
00125 
00129     map<string, string> data ;
00130     const map<string, string> &data_c() const { return data ; }
00131     typedef map<string, string>::const_iterator data_citer ;
00132 
00135     BESInfo *error_info ;
00136 
00137     void dump( ostream &strm ) const ;
00138 
00139 } BESDataHandlerInterface ;
00140 
00159 inline ostream &
00160 operator<<( ostream &strm, const BESDataHandlerInterface &dhi )
00161 {
00162     dhi.dump( strm ) ;
00163     return strm ;
00164 }
00165 
00166 #endif //  BESDataHandlerInterface_h_
00167 

Generated on Tue Mar 4 23:13:34 2008 for OPeNDAP Back End Server (BES) by  doxygen 1.5.1