BESSilentInfo Class Reference

silent informational response object More...

#include <BESSilentInfo.h>

Inheritance diagram for BESSilentInfo:

Inheritance graph
[legend]
Collaboration diagram for BESSilentInfo:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 BESSilentInfo ()
 constructs a BESSilentInfo object for the specified type.
virtual ~BESSilentInfo ()
virtual void begin_response (const string &response_name)
 begin the informational response
virtual void add_tag (const string &tag_name, const string &tag_data, map< string, string > *attrs=0)
 add tagged information to the inforamtional response
virtual void begin_tag (const string &tag_name, map< string, string > *attrs=0)
 begin a tagged part of the information, information to follow
virtual void end_tag (const string &tag_name)
 end a tagged part of the informational response
virtual void add_data (const string &s)
 add data to the inforamtional object
virtual void add_space (unsigned long num_spaces)
 add a space to the informational response
virtual void add_break (unsigned long num_breaks)
 add a line break to the information
virtual void add_data_from_file (const string &key, const string &name)
 ignore data from a file to the informational object.
virtual void add_exception (BESException &e)
 ignore exception data to this informational object. If buffering is not set then the information is output directly to the output stream.
virtual void transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
 transmit the informational object
virtual void print (ostream &strm)
 ignore printing the information
virtual void dump (ostream &strm) const
 dumps information about this object
virtual void end_response ()
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

Detailed Description

silent informational response object

This class ignores any data added to an informational object and ignores the print command. Basically, it is silent!

See also:
BESResponseObject


Constructor & Destructor Documentation

BESSilentInfo::BESSilentInfo (  ) 

constructs a BESSilentInfo object for the specified type.

Parameters:
otype type of data represented by this response object

BESSilentInfo::~BESSilentInfo (  )  [virtual]


Member Function Documentation

void BESSilentInfo::add_break ( unsigned long  num_breaks  )  [virtual]

add a line break to the information

because this is a silent response, nothing is added

Parameters:
s information to be ignored

Implements BESInfo.

void BESSilentInfo::add_data ( const string &  s  )  [virtual]

add data to the inforamtional object

because this is a silent response, nothing is added

Parameters:
s information to be ignored

Reimplemented from BESInfo.

void BESSilentInfo::add_data_from_file ( const string &  key,
const string &  name 
) [virtual]

ignore data from a file to the informational object.

Parameters:
key Key from the initialization file specifying the file to be
name naem information to add to error messages loaded.

Reimplemented from BESInfo.

void BESSilentInfo::add_exception ( BESException e  )  [virtual]

ignore exception data to this informational object. If buffering is not set then the information is output directly to the output stream.

Parameters:
type type of the exception received
msg the error message
file file name of where the error was sent
line line number in the file where the error was sent

Reimplemented from BESInfo.

void BESSilentInfo::add_space ( unsigned long  num_spaces  )  [virtual]

add a space to the informational response

because this is a silent response, nothing is added

Parameters:
num_spaces number of spaces to add

Implements BESInfo.

void BESSilentInfo::add_tag ( const string &  tag_name,
const string &  tag_data,
map< string, string > *  attrs = 0 
) [virtual]

add tagged information to the inforamtional response

Parameters:
tag_name name of the tag to add to the infroamtional response
tag_data information describing the tag

Implements BESInfo.

void BESSilentInfo::begin_response ( const string &  response_name  )  [virtual]

begin the informational response

Because this is silent, there is nothing to do

Parameters:
response_name name of the response represented by the information

Reimplemented from BESInfo.

void BESSilentInfo::begin_tag ( const string &  tag_name,
map< string, string > *  attrs = 0 
) [virtual]

begin a tagged part of the information, information to follow

Parameters:
tag_name name of the tag to begin

Reimplemented from BESInfo.

void BESSilentInfo::dump ( ostream &  strm  )  const [virtual]

dumps information about this object

Displays the pointer value of this instance

Parameters:
strm C++ i/o stream to dump the information to

Reimplemented from BESInfo.

void BESInfo::end_response (  )  [virtual, inherited]

Reimplemented in BESHTMLInfo, BESVersionInfo, and BESXMLInfo.

void BESSilentInfo::end_tag ( const string &  tag_name  )  [virtual]

end a tagged part of the informational response

If the named tag is not the current tag then an error is thrown.

Parameters:
tag_name name of the tag to end

Reimplemented from BESInfo.

virtual bool BESInfo::is_buffered (  )  [inline, virtual, inherited]

return whether the information is to be buffered or not.

Returns:
true if information is buffered, false if not

void BESSilentInfo::print ( ostream &  strm  )  [virtual]

ignore printing the information

Parameters:
strm stream to send output to if not ignored.

Reimplemented from BESInfo.

void BESSilentInfo::transmit ( BESTransmitter transmitter,
BESDataHandlerInterface dhi 
) [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?

Parameters:
transmitter The type of transmitter to use to transmit the info
dhi information to help with the transmission

Implements BESInfo.


Member Data Documentation

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]


The documentation for this class was generated from the following files:
Generated on Wed Nov 21 12:20:22 2007 for OPeNDAP Back End Server (BES) by  doxygen 1.4.7