bes  Updated for version 3.17.4
BESTextInfo.h
1 // BESTextInfo.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 BESTextInfo_h_
34 #define BESTextInfo_h_ 1
35 
36 #include "BESInfo.h"
37 
47 class BESTextInfo : public BESInfo
48 {
49 private:
50  string _indent ;
51  bool _ishttp ;
52  bool _header ;
53 public:
54  BESTextInfo( bool ishttp = false ) ;
55  BESTextInfo( const string &key, ostream *strm,
56  bool strm_owned, bool ishttp = false ) ;
57  virtual ~BESTextInfo() ;
58 
59  virtual void begin_response( const string &response_name,
61 
62  virtual void add_tag( const string &tag_name,
63  const string &tag_data,
64  map<string,string> *attrs = 0 ) ;
65  virtual void begin_tag( const string &tag_name,
66  map<string,string> *attrs = 0 ) ;
67  virtual void end_tag( const string &tag_name ) ;
68 
69  virtual void add_data( const string &s ) ;
70  virtual void add_space( unsigned long num_spaces ) ;
71  virtual void add_break( unsigned long num_breaks ) ;
72 
73  virtual void add_data_from_file( const string &key,
74  const string &name ) ;
75  virtual void transmit( BESTransmitter *transmitter,
77 
78  virtual void dump( ostream &strm ) const ;
79 
80  static BESInfo *BuildTextInfo( const string &info_type ) ;
81 };
82 
83 #endif // BESTextInfo_h_
84 
virtual void begin_response(const string &response_name, BESDataHandlerInterface &dhi)
begin the informational response
Definition: BESTextInfo.cc:96
virtual void add_space(unsigned long num_spaces)
add a space to the informational response
Definition: BESTextInfo.cc:186
virtual void begin_tag(const string &tag_name, map< string, string > *attrs=0)
begin a tagged part of the information, information to follow
Definition: BESTextInfo.cc:133
virtual void dump(ostream &strm) const
dumps information about this object
Definition: BESTextInfo.cc:249
informational response object
Definition: BESInfo.h:68
virtual void add_data_from_file(const string &key, const string &name)
add data from a file to the informational object
Definition: BESTextInfo.cc:220
virtual void add_tag(const string &tag_name, const string &tag_data, map< string, string > *attrs=0)
add tagged information to the inforamtional response
Definition: BESTextInfo.cc:109
BESTextInfo(bool ishttp=false)
constructs a basic text information response object.
Definition: BESTextInfo.cc:50
virtual void end_tag(const string &tag_name)
end a tagged part of the informational response
Definition: BESTextInfo.cc:159
virtual void add_break(unsigned long num_breaks)
add a line break to the information
Definition: BESTextInfo.cc:201
Structure storing information used by the BES to handle the request.
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
transmit the text information as text
Definition: BESTextInfo.cc:235
virtual void add_data(const string &s)
add string data to the informational response
Definition: BESTextInfo.cc:171