bes  Updated for version 3.20.6
BESVersionInfo.h
1 // BESVersionInfo.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 BESVersionInfo_h_
34 #define BESVersionInfo_h_ 1
35 
36 #include "BESInfo.h"
37 
47 class BESVersionInfo: public BESInfo {
48 private:
49  bool _inbes;
50  bool _inhandler;
51  BESInfo * _info;
52  void add_version(const std::string &type, const std::string &name, const std::string &vers);
53 public:
55  virtual ~BESVersionInfo();
56 
57  virtual void add_library(const std::string &n, const std::string &v);
58  virtual void add_module(const std::string &n, const std::string &v);
59  virtual void add_service(const std::string &n, const std::list<std::string> &vers);
60 
61  virtual void begin_response(const std::string &response_name, BESDataHandlerInterface &dhi)
62  {
63  _info->begin_response(response_name, dhi);
64  }
65  virtual void end_response()
66  {
67  _info->end_response();
68  }
69 
70  virtual void add_tag(const std::string &tag_name, const std::string &tag_data, std::map<std::string, std::string> *attrs = 0)
71  {
72  _info->add_tag(tag_name, tag_data, attrs);
73  }
74  virtual void begin_tag(const std::string &tag_name, std::map<std::string, std::string> *attrs = 0)
75  {
76  _info->begin_tag(tag_name, attrs);
77  }
78  virtual void end_tag(const std::string &tag_name)
79  {
80  _info->end_tag(tag_name);
81  }
82 
83  virtual void add_data(const std::string &s)
84  {
85  _info->add_data(s);
86  }
87  virtual void add_space(unsigned long num_spaces)
88  {
89  _info->add_space(num_spaces);
90  }
91  virtual void add_break(unsigned long num_breaks)
92  {
93  _info->add_break(num_breaks);
94  }
95  virtual void add_data_from_file(const std::string &key, const std::string &name)
96  {
97  _info->add_data_from_file(key, name);
98  }
99  virtual void add_exception(BESError &e, const std::string &admin)
100  {
101  _info->add_exception(e, admin);
102  }
103  virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
104  {
105  _info->transmit(transmitter, dhi);
106  }
107  virtual void print(std::ostream &strm)
108  {
109  _info->print(strm);
110  }
111 
112  virtual void dump(std::ostream &strm) const;
113 };
114 
115 #endif // BESVersionInfo_h_
116 
BESVersionInfo::dump
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: BESVersionInfo.cc:98
BESVersionInfo::begin_response
virtual void begin_response(const std::string &response_name, BESDataHandlerInterface &dhi)
begin the informational response
Definition: BESVersionInfo.h:61
BESVersionInfo::transmit
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
transmit the informational object
Definition: BESVersionInfo.h:103
BESInfo::print
virtual void print(std::ostream &strm)
print the information from this informational object to the specified stream
Definition: BESInfo.cc:261
BESInfo::transmit
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)=0
transmit the informational object
BESInfo
informational response object
Definition: BESInfo.h:63
BESInfo::add_data_from_file
virtual void add_data_from_file(const std::string &key, const std::string &name)
add data from a file to the informational object.
Definition: BESInfo.cc:182
BESInfo::add_exception
virtual void add_exception(BESError &e, const std::string &admin)
add exception information to this informational object
Definition: BESInfo.cc:234
BESVersionInfo
Definition: BESVersionInfo.h:47
BESVersionInfo::BESVersionInfo
BESVersionInfo()
constructs a basic text information response object to write version information
Definition: BESVersionInfo.cc:49
BESVersionInfo::print
virtual void print(std::ostream &strm)
print the information from this informational object to the specified stream
Definition: BESVersionInfo.h:107
BESTransmitter
Definition: BESTransmitter.h:47
BESInfo::add_data
virtual void add_data(const std::string &s)
add data to this informational object. If buffering is not set then the information is output directl...
Definition: BESInfo.cc:160
BESVersionInfo::add_data_from_file
virtual void add_data_from_file(const std::string &key, const std::string &name)
add data from a file to the informational object.
Definition: BESVersionInfo.h:95
BESVersionInfo::add_data
virtual void add_data(const std::string &s)
add data to this informational object. If buffering is not set then the information is output directl...
Definition: BESVersionInfo.h:83
BESInfo::begin_response
virtual void begin_response(const std::string &response_name, BESDataHandlerInterface &dhi)
begin the informational response
Definition: BESInfo.cc:124
BESDataHandlerInterface
Structure storing information used by the BES to handle the request.
Definition: BESDataHandlerInterface.h:56
BESError
Abstract exception class for the BES with basic string message.
Definition: BESError.h:58
BESVersionInfo::add_exception
virtual void add_exception(BESError &e, const std::string &admin)
add exception information to this informational object
Definition: BESVersionInfo.h:99