silent informational response object
More...
#include <BESDapErrorInfo.h>
|
virtual void | add_break (unsigned long num_breaks) |
| add a line break to the information More...
|
|
virtual void | add_data (const string &s) |
| add data to the informational object More...
|
|
virtual void | add_data_from_file (const string &key, const string &name) |
| ignore data from a file to the informational object. More...
|
|
virtual void | add_exception (BESError &e, const string &admin) |
| ignore exception data to this informational object. More...
|
|
virtual void | add_space (unsigned long num_spaces) |
| add a space to the informational response More...
|
|
virtual void | add_tag (const string &tag_name, const string &tag_data, map< string, string > *attrs=0) |
| add tagged information to the informational response More...
|
|
virtual void | begin_response (const string &response_name, BESDataHandlerInterface &dhi) |
| begin the informational response More...
|
|
virtual void | begin_tag (const string &tag_name, map< string, string > *attrs=0) |
| begin a tagged part of the information, information to follow More...
|
|
| 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 More...
|
|
virtual void | end_response () |
|
virtual void | end_tag (const string &tag_name) |
| end a tagged part of the informational response More...
|
|
virtual bool | is_buffered () |
| return whether the information is to be buffered or not. More...
|
|
virtual void | print (ostream &strm) |
| ignore printing the information More...
|
|
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
| transmit this informational object More...
|
|
|
bool | _buffered |
|
string | _response_name |
|
bool | _response_started |
|
ostream * | _strm |
|
bool | _strm_owned |
|
stack< string > | _tags |
|
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.
◆ add_break()
void BESDapErrorInfo::add_break |
( |
unsigned long |
num_breaks | ) |
|
|
virtual |
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.
◆ add_data()
void BESDapErrorInfo::add_data |
( |
const string & |
s | ) |
|
|
virtual |
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.
◆ add_data_from_file()
void BESDapErrorInfo::add_data_from_file |
( |
const string & |
key, |
|
|
const string & |
name |
|
) |
| |
|
virtual |
- 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.
◆ add_exception()
void BESDapErrorInfo::add_exception |
( |
BESError & |
e, |
|
|
const string & |
admin |
|
) |
| |
|
virtual |
- Parameters
-
e | exception to be added |
admin | The contact information for the person responsible for this error |
Reimplemented from BESInfo.
Definition at line 152 of file BESDapErrorInfo.cc.
◆ add_space()
void BESDapErrorInfo::add_space |
( |
unsigned long |
num_spaces | ) |
|
|
virtual |
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.
◆ add_tag()
void BESDapErrorInfo::add_tag |
( |
const string & |
tag_name, |
|
|
const string & |
tag_data, |
|
|
map< string, string > * |
attrs = 0 |
|
) |
| |
|
virtual |
- Parameters
-
tag_name | name of the tag to add to the informational 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.
◆ begin_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.
References BESInfo::begin_response().
◆ begin_tag()
void BESDapErrorInfo::begin_tag |
( |
const string & |
tag_name, |
|
|
map< string, string > * |
attrs = 0 |
|
) |
| |
|
virtual |
- 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.
◆ dump()
void BESDapErrorInfo::dump |
( |
ostream & |
strm | ) |
const |
|
virtual |
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 189 of file BESDapErrorInfo.cc.
References BESInfo::dump().
◆ end_tag()
void BESDapErrorInfo::end_tag |
( |
const string & |
tag_name | ) |
|
|
virtual |
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.
◆ is_buffered()
virtual bool BESInfo::is_buffered |
( |
| ) |
|
|
inlinevirtualinherited |
- Returns
- true if information is buffered, false if not
Definition at line 123 of file BESInfo.h.
◆ print()
void BESDapErrorInfo::print |
( |
ostream & |
strm | ) |
|
|
virtual |
◆ transmit()
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 164 of file BESDapErrorInfo.cc.
The documentation for this class was generated from the following files: