BESDataDDXResponseHandler Class Reference

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

#include <BESDataDDXResponseHandler.h>

Inheritance diagram for BESDataDDXResponseHandler:

Collaboration diagram for BESDataDDXResponseHandler:

Public Member Functions
	BESDataDDXResponseHandler (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 ddx for def_name;'
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

Static Public Member Functions
static BESResponseHandler *	DataDDXResponseBuilder (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 DDX object

A request 'get dataddx 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 DDX response object that includes attribute information found in a DAS object and data definitions found in a DDS object. It also knows how to transmit the DDX response object using the specified transmitter object in the transmit method.

See also

DDX

BESContainer

BESDefine

BESTransmitter

Definition at line 52 of file BESDataDDXResponseHandler.h.

Constructor & Destructor Documentation

BESDataDDXResponseHandler()

BESDataDDXResponseHandler::BESDataDDXResponseHandler

(

const std::string &

name

)

Definition at line 49 of file BESDataDDXResponseHandler.cc.

~BESDataDDXResponseHandler()

BESDataDDXResponseHandler::~BESDataDDXResponseHandler ( void )

virtual

Definition at line 54 of file BESDataDDXResponseHandler.cc.

Member Function Documentation

DataDDXResponseBuilder()

BESResponseHandler * BESDataDDXResponseHandler::DataDDXResponseBuilder ( const std::string & name )

static

Definition at line 167 of file BESDataDDXResponseHandler.cc.

dump()

void BESDataDDXResponseHandler::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 157 of file BESDataDDXResponseHandler.cc.

execute()

void BESDataDDXResponseHandler::execute ( BESDataHandlerInterface & dhi )

virtual

executes the command 'get ddx for def_name;'

For each container in the specified definition go to the request handler for that container and have it first add to the OPeNDAP DDS response object. Once the DDS object has been filled in, repeat the process but this time for the OPeNDAP DAS response object. Then add the attributes from the DAS object to the DDS object.

Parameters

dhi	structure that holds request and response information

See also

BESDataHandlerInterface

BESDDSResponse

BESDASResponse

BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 73 of file BESDataDDXResponseHandler.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 BESDataDDXResponseHandler::transmit ( BESTransmitter * transmitter, BESDataHandlerInterface & dhi )

virtual

transmit the response object built by the execute command

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

Parameters

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

See also

DDS

DAS

BESTransmitter

BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 141 of file BESDataDDXResponseHandler.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:

• BESDataDDXResponseHandler.h
• BESDataDDXResponseHandler.cc