libdap++ Updated for version 3.8.2

libdap::Error Class Reference

A class for error processing. More...

#include <Error.h>

Inheritance diagram for libdap::Error:
Collaboration diagram for libdap::Error:

List of all members.

Public Member Functions

 Error (ErrorCode ec, string msg)
 Error (string msg)
 Error (const Error &copy_from)
 Error ()
ErrorCode get_error_code () const
string get_error_message () const
bool OK () const
 Is the Error object valid?
Erroroperator= (const Error &rhs)
bool parse (FILE *fp)
 Parse an Error object.
void print (FILE *out) const
void print (ostream &out) const
void set_error_code (ErrorCode ec=undefined_error)
void set_error_message (string msg="")
virtual ~Error ()

Protected Attributes

ErrorCode _error_code
string _error_message

Detailed Description

The Error class is used to transport error information from the server to the client within libdap. This class is also the base class for all the errors thrown by methods in the DAP, so catching Error will catch all DAP throws. Errors consist of an error code and a string. The code can be used to quickly distinguish between certain common errors while the string is used to convey information about the error to the user. The error code should never be displayed to the user.

This class is used on both clients and servers. The print() and parse() methods are used to send the object back and forth.

Note:
A past version of this class supported the notion of an error correcting program (Tcl, Java, ...) that could be sent from the server to the client to help users correct the error and resubmit the request. This never worked well in practice and that feature of the class is deprecated.
Author:
jhrg

Definition at line 90 of file Error.h.


Constructor & Destructor Documentation

libdap::Error::Error ( ErrorCode  ec,
string  msg 
)

Create an instance with a specific code and message string. This ctor provides a way to to use any code and string you'd like. The code can be one of the standard codes or it may be specific to your server. Thus a client which can tell it's dealing with a specific type of server can use the code accordingly. In general, clients simply show the error message to users or write it to a log file.

Parameters:
ecThe error code
msgThe error message string.

Definition at line 89 of file Error.cc.

libdap::Error::Error ( string  msg)

Create an instance with a specific message. The error code is set to unknown_error.

Parameters:
msgThe error message.
See also:
ErrorCode

Definition at line 98 of file Error.cc.

libdap::Error::Error ( )

Specializations of Error should use this to set the error code and message.

Definition at line 77 of file Error.cc.

libdap::Error::Error ( const Error copy_from)

Definition at line 102 of file Error.cc.

libdap::Error::~Error ( ) [virtual]

Definition at line 108 of file Error.cc.


Member Function Documentation

ErrorCode libdap::Error::get_error_code ( ) const

Get the ErrorCode for this instance.

Definition at line 250 of file Error.cc.

References _error_code, and OK().

Here is the call graph for this function:

string libdap::Error::get_error_message ( ) const

Return the current error message.

Definition at line 279 of file Error.cc.

References _error_message, and OK().

Referenced by libdap::HTTPCache::cache_response(), main(), parse(), and libdap::HTTPCache::~HTTPCache().

Here is the call graph for this function:

bool libdap::Error::OK ( ) const

Use this function to determine whether an Error object is valid. To be a valid, an Error object must either be: 1) empty or contain a message and a code.

Returns:
TRUE if the object is valid, FALSE otherwise.

Definition at line 136 of file Error.cc.

References _error_code, _error_message, DBG, and undefined_error.

Referenced by get_error_code(), get_error_message(), operator=(), parse(), and print().

Error & libdap::Error::operator= ( const Error rhs)

Definition at line 113 of file Error.cc.

References _error_code, _error_message, and OK().

Here is the call graph for this function:

bool libdap::Error::parse ( FILE *  fp)

Given an input stream (FILE *) fp, parse an Error object from stream. Values for fields of the Error object are parsed and this is set accordingly. This is how a client program receives an error object from a server.

Parameters:
fpA valid file pointer to an input stream.
Returns:
TRUE if no error was detected, FALSE otherwise.

Definition at line 159 of file Error.cc.

References Error_buffer(), Error_delete_buffer(), Error_switch_to_buffer(), Errorparse(), get_error_message(), OK(), and libdap::parser_arg::status().

Referenced by libdap::Connect::request_das(), libdap::Connect::request_das_url(), libdap::Connect::request_dds(), libdap::Connect::request_dds_url(), libdap::Connect::request_ddx(), and libdap::Connect::request_ddx_url().

Here is the call graph for this function:

void libdap::Error::print ( ostream &  strm) const

Creates a printable representation of the Error object. It is suitable for framing, and also for printing and sending over a network.

The printed representation produced by this function can be parsed by the parse() member function. Thus parse and print form a symmetrical pair that can be used to send and receive an Error object over the network in a MIME document.

Parameters:
strmA reference to the output stream on which the Error object is to be rendered.

Definition at line 230 of file Error.cc.

References _error_code, _error_message, and OK().

Here is the call graph for this function:

void libdap::Error::print ( FILE *  out) const

Creates a printable representation of the Error object. It is suitable for framing, and also for printing and sending over a network.

The printed representation produced by this function can be parsed by the parse() member function. Thus parse and print form a symmetrical pair that can be used to send and receive an Error object over the network in a MIME document.

Parameters:
outA pointer to the output stream on which the Error object is to be rendered.

Definition at line 201 of file Error.cc.

References _error_code, _error_message, and OK().

Here is the call graph for this function:

void libdap::Error::set_error_code ( ErrorCode  ec = undefined_error)

Set the ErrorCode. If the current error message has not been set, use ec to set the error message. The resulting error message string is the same as the ErrorCode name. If ec is not within the range of values for an OPeNDAP ErrorCode, the error message is left unchanged.

Parameters:
ecThe new ErrorCode value.

Definition at line 263 of file Error.cc.

References _error_code, _error_message, cannot_read_file, and undefined_error.

void libdap::Error::set_error_message ( string  msg = "")

Set the error message.

Definition at line 288 of file Error.cc.

References _error_message.


Member Data Documentation


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