BESDapErrorInfo Class Reference

silent informational response object More...

#include <BESDapErrorInfo.h>

Inheritance diagram for BESDapErrorInfo:
Inheritance graph
[legend]
Collaboration diagram for BESDapErrorInfo:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual void add_break (unsigned long num_breaks)
 add a line break to the information
virtual void add_data (const string &s)
 add data to the inforamtional object
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 (BESError &e, const string &admin)
 ignore exception data to this informational object.
virtual void add_space (unsigned long num_spaces)
 add a space to 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_response (const string &response_name, BESDataHandlerInterface &dhi)
 begin the informational response
virtual void begin_tag (const string &tag_name, map< string, string > *attrs=0)
 begin a tagged part of the information, information to follow
 BESDapErrorInfo (ErrorCode ec, const string &msg)
 constructs an informational object that doesn't write any output to the stream
virtual void dump (ostream &strm) const
 dumps information about this object
virtual void end_response ()
virtual void end_tag (const string &tag_name)
 end a tagged part of the informational response
virtual bool is_buffered ()
 return whether the information is to be buffered or not.
virtual void print (ostream &strm)
 ignore printing the information
virtual void transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
 transmit this informational object
virtual ~BESDapErrorInfo ()

Protected Attributes

bool _buffered
string _response_name
bool _response_started
ostream * _strm
bool _strm_owned
stack< string > _tags

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

Definition at line 52 of file BESDapErrorInfo.h.


Constructor & Destructor Documentation

BESDapErrorInfo::BESDapErrorInfo ( ErrorCode  ec,
const string &  msg 
)

constructs an informational object that doesn't write any output to the stream

Definition at line 38 of file BESDapErrorInfo.cc.

BESDapErrorInfo::~BESDapErrorInfo (  )  [virtual]

Definition at line 45 of file BESDapErrorInfo.cc.


Member Function Documentation

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

add a line break to the information

because this is a silent response, nothing is added

Parameters:
num_breaks number of line breaks to add

Implements BESInfo.

Definition at line 129 of file BESDapErrorInfo.cc.

void BESDapErrorInfo::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.

Definition at line 107 of file BESDapErrorInfo.cc.

void BESDapErrorInfo::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.

Definition at line 140 of file BESDapErrorInfo.cc.

void BESDapErrorInfo::add_exception ( BESError e,
const string &  admin 
) [virtual]

ignore exception data to this informational object.

Parameters:
e exception to be added

Reimplemented from BESInfo.

Definition at line 149 of file BESDapErrorInfo.cc.

void BESDapErrorInfo::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.

Definition at line 118 of file BESDapErrorInfo.cc.

void BESDapErrorInfo::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
attrs map of attributes to add to the tag

Implements BESInfo.

Definition at line 70 of file BESDapErrorInfo.cc.

void BESDapErrorInfo::begin_response ( const string &  response_name,
BESDataHandlerInterface dhi 
) [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
dhi information about the request and response

Reimplemented from BESInfo.

Definition at line 57 of file BESDapErrorInfo.cc.

void BESDapErrorInfo::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
attrs map of attributes to begin the tag with

Reimplemented from BESInfo.

Definition at line 82 of file BESDapErrorInfo.cc.

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

dumps information about this object

Displays the pointer value of this instance and calls dump on the parent class

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

Reimplemented from BESInfo.

Definition at line 186 of file BESDapErrorInfo.cc.

References BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Here is the call graph for this function:

void BESInfo::end_response (  )  [virtual, inherited]
void BESDapErrorInfo::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.

Definition at line 95 of file BESDapErrorInfo.cc.

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

Definition at line 123 of file BESInfo.h.

References BESInfo::_buffered.

Referenced by BESFilterTransmitter::send_html(), BESBasicHttpTransmitter::send_html(), BESFilterTransmitter::send_text(), and BESBasicHttpTransmitter::send_text().

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

ignore printing the information

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

Reimplemented from BESInfo.

Definition at line 172 of file BESDapErrorInfo.cc.

void BESDapErrorInfo::transmit ( BESTransmitter transmitter,
BESDataHandlerInterface dhi 
) [virtual]

transmit this informational object

transmit this as text to the transmitter

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

Implements BESInfo.

Definition at line 161 of file BESDapErrorInfo.cc.

References BESTransmitter::send_text().

Here is the call graph for this function:


Member Data Documentation

bool BESInfo::_buffered [protected, inherited]
string BESInfo::_response_name [protected, inherited]
bool BESInfo::_response_started [protected, inherited]

Definition at line 74 of file BESInfo.h.

Referenced by BESInfo::begin_response(), BESInfo::dump(), and BESInfo::end_response().

ostream* BESInfo::_strm [protected, inherited]
bool BESInfo::_strm_owned [protected, inherited]

Definition at line 72 of file BESInfo.h.

Referenced by BESInfo::BESInfo(), and BESInfo::~BESInfo().

stack<string> BESInfo::_tags [protected, inherited]

The documentation for this class was generated from the following files:

Generated on 19 Feb 2010 for OPeNDAP Hyrax Back End Server (BES) by  doxygen 1.6.1