#include <BESVersionInfo.h>
Inheritance diagram for BESVersionInfo:
Public Member Functions | |
BESVersionInfo () | |
constructs a basic text information response object. | |
virtual | ~BESVersionInfo () |
virtual void | beginBESVersion () |
virtual void | addBESVersion (const string &n, const string &v) |
virtual void | endBESVersion () |
virtual void | beginHandlerVersion () |
virtual void | addHandlerVersion (const string &n, const string &v) |
virtual void | endHandlerVersion () |
virtual void | begin_response (const string &response_name) |
virtual void | end_response () |
virtual void | add_tag (const string &tag_name, const string &tag_data, map< string, string > *attrs=0) |
virtual void | begin_tag (const string &tag_name, map< string, string > *attrs=0) |
virtual void | end_tag (const string &tag_name) |
virtual void | add_data (const string &s) |
add data to this informational object. If buffering is not set then the information is output directly to the output stream. | |
virtual void | add_space (unsigned long num_spaces) |
virtual void | add_break (unsigned long num_breaks) |
virtual void | add_data_from_file (const string &key, const string &name) |
add data from a file to the informational object. | |
virtual void | add_exception (BESException &e) |
add exception information to this informational object | |
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the informational object | |
virtual void | print (ostream &strm) |
print the information from this informational object to the specified stream | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual bool | is_buffered () |
return whether the information is to be buffered or not. | |
Protected Attributes | |
ostream * | _strm |
bool | _strm_owned |
bool | _buffered |
bool | _response_started |
stack< string > | _tags |
string | _response_name |
Uses the default add_data and print methods, where the print method, if the response is going to a browser, sets the mime type to text.
BESVersionInfo::BESVersionInfo | ( | ) |
constructs a basic text information response object.
Uses the default BES.Info.Buffered key in the dods initialization file to determine whether the information should be buffered or not.
BESVersionInfo::~BESVersionInfo | ( | ) | [virtual] |
virtual void BESVersionInfo::add_break | ( | unsigned long | num_breaks | ) | [inline, virtual] |
virtual void BESVersionInfo::add_data | ( | const string & | s | ) | [inline, virtual] |
add data to this informational object. If buffering is not set then the information is output directly to the output stream.
s | information to be added to this informational response object |
Reimplemented from BESInfo.
Here is the call graph for this function:
virtual void BESVersionInfo::add_data_from_file | ( | const string & | key, | |
const string & | name | |||
) | [inline, virtual] |
add data from a file to the informational object.
Adds data from a file to the informational object using the file specified by the passed key string. The key is found from the bes configuration file.
If the key does not exist in the initialization file then this information is added to the informational object, no excetion is thrown.
If the file does not exist then this information is added to the informational object, no exception is thrown.
key | Key from the initialization file specifying the file to be | |
name | A description of what is the information being loaded |
Reimplemented from BESInfo.
Here is the call graph for this function:
virtual void BESVersionInfo::add_exception | ( | BESException & | e | ) | [inline, virtual] |
add exception information to this informational object
Exception information is added differently to different informational objects, such as html, xml, plain text. But, using the other methods of this class we can take care of exceptions here.
type | The type of exception being thrown | |
e | The exception to add to the informational response object |
Reimplemented from BESInfo.
Here is the call graph for this function:
virtual void BESVersionInfo::add_space | ( | unsigned long | num_spaces | ) | [inline, virtual] |
virtual void BESVersionInfo::add_tag | ( | const string & | tag_name, | |
const string & | tag_data, | |||
map< string, string > * | attrs = 0 | |||
) | [inline, virtual] |
void BESVersionInfo::addBESVersion | ( | const string & | n, | |
const string & | v | |||
) | [virtual] |
void BESVersionInfo::addHandlerVersion | ( | const string & | n, | |
const string & | v | |||
) | [virtual] |
virtual void BESVersionInfo::begin_response | ( | const string & | response_name | ) | [inline, virtual] |
virtual void BESVersionInfo::begin_tag | ( | const string & | tag_name, | |
map< string, string > * | attrs = 0 | |||
) | [inline, virtual] |
void BESVersionInfo::beginBESVersion | ( | ) | [virtual] |
void BESVersionInfo::beginHandlerVersion | ( | ) | [virtual] |
void BESVersionInfo::dump | ( | ostream & | strm | ) | const [virtual] |
dumps information about this object
Displays the pointer value of this instance along with information about this version information object
strm | C++ i/o stream to dump the information to |
Reimplemented from BESInfo.
virtual void BESVersionInfo::end_response | ( | ) | [inline, virtual] |
virtual void BESVersionInfo::end_tag | ( | const string & | tag_name | ) | [inline, virtual] |
void BESVersionInfo::endBESVersion | ( | ) | [virtual] |
void BESVersionInfo::endHandlerVersion | ( | ) | [virtual] |
virtual bool BESInfo::is_buffered | ( | ) | [inline, virtual, inherited] |
return whether the information is to be buffered or not.
virtual void BESVersionInfo::print | ( | ostream & | strm | ) | [inline, virtual] |
print the information from this informational object to the specified stream
If the information was not buffered then this method does nothing, otherwise the information is output to the specified ostream.
out | output to this file descriptor if information buffered. |
Reimplemented from BESInfo.
Here is the call graph for this function:
virtual void BESVersionInfo::transmit | ( | BESTransmitter * | transmitter, | |
BESDataHandlerInterface & | dhi | |||
) | [inline, virtual] |
transmit the informational object
The derived informational object knows how it needs to be transmitted. Does it need to be sent as html? As text? As something else?
transmitter | The type of transmitter to use to transmit the info | |
dhi | information to help with the transmission |
Implements BESInfo.
Here is the call graph for this function:
bool BESInfo::_buffered [protected, inherited] |
string BESInfo::_response_name [protected, inherited] |
bool BESInfo::_response_started [protected, inherited] |
ostream* BESInfo::_strm [protected, inherited] |
bool BESInfo::_strm_owned [protected, inherited] |
stack<string> BESInfo::_tags [protected, inherited] |