bes  Updated for version 3.19.1
BESInfo.h
1 // BESInfo.h
2 
3 // This file is part of bes, A C++ back-end server implementation framework
4 // for the OPeNDAP Data Access Protocol.
5 
6 // Copyright (c) 2004-2009 University Corporation for Atmospheric Research
7 // Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
8 //
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU Lesser General Public
11 // License as published by the Free Software Foundation; either
12 // version 2.1 of the License, or (at your option) any later version.
13 //
14 // This library is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // Lesser General Public License for more details.
18 //
19 // You should have received a copy of the GNU Lesser General Public
20 // License along with this library; if not, write to the Free Software
21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 //
23 // You can contact University Corporation for Atmospheric Research at
24 // 3080 Center Green Drive, Boulder, CO 80301
25 
26 // (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
27 // Please read the full copyright statement in the file COPYRIGHT_UCAR.
28 //
29 // Authors:
30 // pwest Patrick West <pwest@ucar.edu>
31 // jgarcia Jose Garcia <jgarcia@ucar.edu>
32 
33 #ifndef BESInfo_h_
34 #define BESInfo_h_ 1
35 
36 #include <string>
37 #include <ostream>
38 #include <stack>
39 #include <map>
40 
41 using std::string ;
42 using std::ostream ;
43 using std::stack ;
44 using std::map ;
45 
46 #include "BESResponseObject.h"
47 #include "BESDataHandlerInterface.h"
48 #include "BESTransmitter.h"
49 #include "BESError.h"
50 
69 {
70 protected:
71  ostream *_strm ;
72  bool _strm_owned ;
73  bool _buffered ;
74  bool _response_started ;
75 
76  stack<string> _tags ;
77  string _response_name ;
78 
79 public:
80  BESInfo( ) ;
81  BESInfo( const string &buffered_key,
82  ostream *strm, bool strm_owned ) ;
83  virtual ~BESInfo() ;
84 
85  virtual void begin_response( const string &response_name,
87  virtual void end_response( ) ;
88 
89  virtual void add_tag( const string &tag_name,
90  const string &tag_data,
91  map<string,string> *attrs = 0 ) = 0 ;
92  virtual void begin_tag( const string &tag_name,
93  map<string,string> *attrs = 0 ) ;
94  virtual void end_tag( const string &tag_name ) ;
95 
96  virtual void add_data( const string &s ) ;
97  virtual void add_space( unsigned long num_spaces ) = 0 ;
98  virtual void add_break( unsigned long num_breaks ) = 0 ;
99 
100  virtual void add_data_from_file( const string &key,
101  const string &name ) ;
102 
103  virtual void add_exception( BESError &e, const string &admin ) ;
104 
114  virtual void transmit( BESTransmitter *transmitter,
115  BESDataHandlerInterface &dhi ) = 0 ;
116 
117  virtual void print( ostream &strm ) ;
118 
123  virtual bool is_buffered() { return _buffered ; }
124 
129  virtual void dump( ostream &strm ) const ;
130 };
131 
132 #endif // BESInfo_h_
133 
virtual void dump(ostream &strm) const
Displays debug information about this object.
Definition: BESInfo.cc:263
virtual void add_data_from_file(const string &key, const string &name)
add data from a file to the informational object.
Definition: BESInfo.cc:170
BESInfo()
constructs a BESInfo object
Definition: BESInfo.cc:53
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)=0
transmit the informational object
virtual bool is_buffered()
return whether the information is to be buffered or not.
Definition: BESInfo.h:123
informational response object
Definition: BESInfo.h:68
Abstract exception class for the BES with basic string message.
Definition: BESError.h:56
virtual void add_exception(BESError &e, const string &admin)
add exception information to this informational object
Definition: BESInfo.cc:222
Structure storing information used by the BES to handle the request.
virtual void begin_response(const string &response_name, BESDataHandlerInterface &dhi)
begin the informational response
Definition: BESInfo.cc:112
virtual void add_data(const string &s)
add data to this informational object. If buffering is not set then the information is output directl...
Definition: BESInfo.cc:148
virtual void print(ostream &strm)
print the information from this informational object to the specified stream
Definition: BESInfo.cc:249
Abstract base class representing a specific set of information in response to a request to the BES...