BESDASResponseHandler Class Reference

response handler that builds an OPeNDAP DAS response object More...

#include <BESDASResponseHandler.h>

Inheritance diagram for BESDASResponseHandler:

Collaboration diagram for BESDASResponseHandler:

Public Member Functions
	BESDASResponseHandler (const std::string &name)
virtual void	dump (std::ostream &strm) const
	dumps information about this object
virtual void	execute (BESDataHandlerInterface &dhi)
	executes the command <get type="das" definition=...>
virtual BESResponseObject *	get_response_object ()
	return the current response object
virtual BESResponseObject *	set_response_object (BESResponseObject *o)
	replaces the current response object with the specified one, returning the current response object
virtual void	transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
	transmit the response object built by the execute command using the specified transmitter object

Static Public Member Functions
static BESResponseHandler *	DASResponseBuilder (const std::string &name)

Protected Attributes
std::string	d_annotation_service_url
std::string	d_response_name
BESResponseObject *	d_response_object = nullptr

Detailed Description

response handler that builds an OPeNDAP DAS response object

A request 'get das for <def_name>;' will be handled by this response handler. Given a definition name it determines what containers are to be used to build the OPeNDAP DAS response object. It then transmits the DAS object using the method send_das on the speicifed transmitter object.

See also

DAS

BESContainer

BESTransmitter

Definition at line 50 of file BESDASResponseHandler.h.

Constructor & Destructor Documentation

BESDASResponseHandler()

BESDASResponseHandler::BESDASResponseHandler

(

const std::string &

name

)

Definition at line 51 of file BESDASResponseHandler.cc.

~BESDASResponseHandler()

BESDASResponseHandler::~BESDASResponseHandler ( )

virtual

Definition at line 56 of file BESDASResponseHandler.cc.

Member Function Documentation

DASResponseBuilder()

BESResponseHandler * BESDASResponseHandler::DASResponseBuilder ( const std::string & name )

static

Definition at line 170 of file BESDASResponseHandler.cc.

dump()

void BESDASResponseHandler::dump ( std::ostream & strm ) const

virtual

dumps information about this object

Displays the pointer value of this instance

Parameters

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

Implements BESObj.

Definition at line 160 of file BESDASResponseHandler.cc.

execute()

void BESDASResponseHandler::execute ( BESDataHandlerInterface & dhi )

virtual

executes the command <get type="das" definition=...>

For each container in the specified definition go to the request handler for that container and have it add to the OPeNDAP DAS response object. The DAS response object is built within this method and passed to the request handler list. This command will read the DAS from the MDS if that has been configured and the response is found there.

DAS responses are added to the MDS when a request for either the DMR or DDS is made.

Parameters

dhi	structure that holds request and response information

See also

BESDataHandlerInterface

BESDASResponse

BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 79 of file BESDASResponseHandler.cc.

get_response_object()

BESResponseObject * BESResponseHandler::get_response_object ( )

virtualinherited

return the current response object

Returns the current response object, null if one has not yet been created. The response handler maintains ownership of the response object.

Returns

current response object

See also

BESResponseObject

Definition at line 62 of file BESResponseHandler.cc.

set_response_object()

BESResponseObject * BESResponseHandler::set_response_object ( BESResponseObject * o )

virtualinherited

replaces the current response object with the specified one, returning the current response object

This method is used to replace the response object with a new one, for example if during aggregation a new response object is built from the current response object.

The caller of set_response_object now owns the returned response object. The new response object is now owned by the response object.

Parameters

o	new response object used to replace the current one

Returns

the response object being replaced

See also

BESResponseObject

Definition at line 68 of file BESResponseHandler.cc.

transmit()

void BESDASResponseHandler::transmit ( BESTransmitter * transmitter, BESDataHandlerInterface & dhi )

virtual

transmit the response object built by the execute command using the specified transmitter object

If a response object was built then transmit it using the send_das method on the transmitter object.

Parameters

transmitter	object that knows how to transmit specific basic types
dhi	structure that holds the request and response information

See also

BESDASResponse

BESTransmitter

BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 144 of file BESDASResponseHandler.cc.

Member Data Documentation

d_annotation_service_url

std::string BESResponseHandler::d_annotation_service_url

protectedinherited

Definition at line 82 of file BESResponseHandler.h.

d_response_name

std::string BESResponseHandler::d_response_name

protectedinherited

Definition at line 79 of file BESResponseHandler.h.

d_response_object

BESResponseObject* BESResponseHandler::d_response_object = nullptr

protectedinherited

Definition at line 80 of file BESResponseHandler.h.

---

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

• BESDASResponseHandler.h
• BESDASResponseHandler.cc