BESSetContainerResponseHandler Class Reference

response handler that creates a container given the symbolic name, real name, and data type. More...

#include <BESSetContainerResponseHandler.h>

Inheritance diagram for BESSetContainerResponseHandler:

Collaboration diagram for BESSetContainerResponseHandler:

Public Member Functions
	BESSetContainerResponseHandler (const std::string &name)
virtual void	dump (std::ostream &strm) const
	dumps information about this object
virtual void	execute (BESDataHandlerInterface &dhi)
	executes the command to create a new container or replaces an already existing container based on the provided symbolic 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)
	The setContainer command does not return a response.

Static Public Member Functions
static BESResponseHandler *	SetContainerResponseBuilder (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 creates a container given the symbolic name, real name, and data type.

This request handler creates a new container, or replaces an already existing container in the specified container storage given the symbolic name, real name (in most cases a file name), and the type of data represented by the real name (e.g. netcdf, cedar, cdf, hdf, etc...) The request has the syntax:

set container in <store_name> values <sym_name>,<real_name>,<data_type>;

It returns whether the container was created or replaces successfully in an informational response object and transmits that response object.

See also

BESResponseObject

BESContainer

BESTransmitter

Definition at line 56 of file BESSetContainerResponseHandler.h.

Constructor & Destructor Documentation

BESSetContainerResponseHandler()

BESSetContainerResponseHandler::BESSetContainerResponseHandler

(

const std::string &

name

)

Definition at line 54 of file BESSetContainerResponseHandler.cc.

~BESSetContainerResponseHandler()

BESSetContainerResponseHandler::~BESSetContainerResponseHandler ( void )

virtual

Definition at line 59 of file BESSetContainerResponseHandler.cc.

Member Function Documentation

dump()

void BESSetContainerResponseHandler::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

Reimplemented from BESResponseHandler.

Definition at line 124 of file BESSetContainerResponseHandler.cc.

execute()

void BESSetContainerResponseHandler::execute ( BESDataHandlerInterface & dhi )

virtual

executes the command to create a new container or replaces an already existing container based on the provided symbolic name.

The symbolic name is first looked up in the specified container storage object, volatile if no container storage name is specified. If the symbolic name already exists (the container already exists) then the already existing container is removed and the new one added using the given real name (usually a file name) and the type of data represented by this container (e.g. cedar, cdf, netcdf, hdf, etc...)

Parameters

dhi	structure that holds request and response information

Exceptions

BESSyntaxUserError

if the specified store name does not exist

See also

BESDataHandlerInterface

BESInfo

BESContainerStorageList

BESContainerStorage

BESContainer

Implements BESResponseHandler.

Definition at line 82 of file BESSetContainerResponseHandler.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.

SetContainerResponseBuilder()

BESResponseHandler * BESSetContainerResponseHandler::SetContainerResponseBuilder ( const std::string & name )

static

Definition at line 133 of file BESSetContainerResponseHandler.cc.

transmit()

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

virtual

The setContainer command does not return a response.

Parameters

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

See also

BESInfo

BESTransmitter

BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 114 of file BESSetContainerResponseHandler.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:

• BESSetContainerResponseHandler.h
• BESSetContainerResponseHandler.cc