OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESDapErrorInfo Class Reference

silent informational response object More...

#include <BESDapErrorInfo.h>

Inheritance diagram for BESDapErrorInfo:
Inheritance graph
Collaboration diagram for BESDapErrorInfo:
Collaboration graph

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 informational 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 informational 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_breaksnumber 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 informational object

because this is a silent response, nothing is added

Parameters:
sinformation 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:
keyKey from the initialization file specifying the file to be
namenaem 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:
eexception to be added
adminThe contact information for the person responsible for this error

Reimplemented from BESInfo.

Definition at line 152 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_spacesnumber 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 informational response

Parameters:
tag_namename of the tag to add to the informational response
tag_datainformation describing the tag
attrsmap 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_namename of the response represented by the information
dhiinformation 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_namename of the tag to begin
attrsmap 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:
strmC++ i/o stream to dump the information to

Reimplemented from BESInfo.

Definition at line 189 of file BESDapErrorInfo.cc.

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

Here is the call graph for this function:

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_namename of the tag to end

Reimplemented from BESInfo.

Definition at line 95 of file BESDapErrorInfo.cc.

virtual bool BESInfo::is_buffered ( )
inlinevirtualinherited

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 BESBasicHttpTransmitter::send_html(), BESBasicTransmitter::send_html(), BESBasicTransmitter::send_text(), and BESBasicHttpTransmitter::send_text().

void BESDapErrorInfo::print ( ostream &  strm)
virtual

ignore printing the information

Parameters:
strmstream to send output to if not ignored.

Reimplemented from BESInfo.

Definition at line 175 of file BESDapErrorInfo.cc.

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

transmit this informational object

transmit this as text to the transmitter

Parameters:
transmitterThe type of transmitter to use to transmit the info
dhiinformation to help with the transmission

Implements BESInfo.

Definition at line 164 of file BESDapErrorInfo.cc.

References BESTransmitter::send_text().

Here is the call graph for this function:


Member Data Documentation

bool BESInfo::_buffered
protectedinherited
bool BESInfo::_response_started
protectedinherited

Definition at line 74 of file BESInfo.h.

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

ostream* BESInfo::_strm
protectedinherited
bool BESInfo::_strm_owned
protectedinherited

Definition at line 72 of file BESInfo.h.

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

stack<string> BESInfo::_tags
protectedinherited

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