bes  Updated for version 3.17.4
DapFunctionsRequestHandler Class Reference

A Request Handler for the DAP Functions module. More...

#include <DapFunctionsRequestHandler.h>

Inheritance diagram for DapFunctionsRequestHandler:
Inheritance graph

Public Types

typedef map< string, p_request_handler >::const_iterator Handler_citer
 
typedef map< string, p_request_handler >::iterator Handler_iter
 

Public Member Functions

virtual bool add_handler (const string &handler_name, p_request_handler handler_method)
 add a handler method to the request handler that knows how to fill in a specific response object More...
 
 DapFunctionsRequestHandler (const std::string &name)
 Constructor for FileOut NetCDF module. More...
 
virtual void dump (std::ostream &strm) const
 dumps information about this object More...
 
virtual p_request_handler find_handler (const string &handler_name)
 find the method that can handle the specified response object type More...
 
virtual string get_handler_names ()
 return a comma separated list of response object types handled by this request handler More...
 
virtual const string & get_name () const
 
virtual bool remove_handler (const string &handler_name)
 remove the specified handler method from this request handler More...
 

Static Public Member Functions

static bool build_help (BESDataHandlerInterface &dhi)
 Provides information for the DAP functions help request. More...
 
static bool build_version (BESDataHandlerInterface &dhi)
 add version information to a version response More...
 

Detailed Description

Definition at line 39 of file DapFunctionsRequestHandler.h.

Constructor & Destructor Documentation

◆ DapFunctionsRequestHandler()

DapFunctionsRequestHandler::DapFunctionsRequestHandler ( const std::string &  name)

This constructor adds functions to add to the build of a help request and a version request to the BES.

Parameters
nameThe name of the request handler being added to the list of request handlers

Definition at line 45 of file DapFunctionsRequestHandler.cc.

References BESRequestHandler::add_handler(), build_help(), and build_version().

Member Function Documentation

◆ add_handler()

bool BESRequestHandler::add_handler ( const string &  handler_name,
p_request_handler  handler_method 
)
virtualinherited

Add a handler method for a specific response object to the request handler. The handler method takes a reference to a BESDataHandlerInterface and returns bool, true if the response object is filled in successfully by the method, false otherwise.

Parameters
handler_namename of the response object this method can fill in
handler_methoda function pointer to the method that can fill in the specified response object
Returns
true if the handler is added, false if it already exists
See also
BESResponseObject
BESResponseNames

Definition at line 50 of file BESRequestHandler.cc.

References BESRequestHandler::find_handler().

◆ build_help()

bool DapFunctionsRequestHandler::build_help ( BESDataHandlerInterface dhi)
static
Parameters
dhiThe data interface containing information for the current request to the BES
Exceptions
BESInternalErrorif the response object is not an informational response object.

Definition at line 59 of file DapFunctionsRequestHandler.cc.

References BESResponseHandler::get_response_object(), BESKeys::get_value(), and TheBESKeys::TheKeys().

◆ build_version()

bool DapFunctionsRequestHandler::build_version ( BESDataHandlerInterface dhi)
static

Adds the version of this module to the version response.

Parameters
dhiThe data interface containing information for the current request to the BES

Definition at line 89 of file DapFunctionsRequestHandler.cc.

References BESResponseHandler::get_response_object().

◆ dump()

void DapFunctionsRequestHandler::dump ( std::ostream &  strm) const
virtual

Displays the pointer value of this instance

Parameters
strmC++ i/o stream to dump the information to

Reimplemented from BESRequestHandler.

Definition at line 106 of file DapFunctionsRequestHandler.cc.

References BESRequestHandler::dump().

◆ find_handler()

p_request_handler BESRequestHandler::find_handler ( const string &  handler_name)
virtualinherited

Find the method that can handle the specified response object type. The response object type is the same as the handler name.

Parameters
handler_namename of the method that can fill in the response object type
Returns
the method that can fill in the specified response object type
See also
BESResponseObject
BESResponseNames

Definition at line 87 of file BESRequestHandler.cc.

◆ get_handler_names()

string BESRequestHandler::get_handler_names ( )
virtualinherited
Returns
the comma separated list of response object types
See also
BESResponseObject
BESResponseNames

Definition at line 104 of file BESRequestHandler.cc.

◆ remove_handler()

bool BESRequestHandler::remove_handler ( const string &  handler_name)
virtualinherited
Parameters
handler_namename of the method to be removed, same as the name of the response object
Returns
true if successfully removed, false if not found
See also
BESResponseNames

Definition at line 66 of file BESRequestHandler.cc.


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