#include <BESDefineResponseHandler.h>
Inheritance diagram for BESDefineResponseHandler:
Public Member Functions | |
BESDefineResponseHandler (string name) | |
virtual | ~BESDefineResponseHandler (void) |
virtual void | execute (BESDataHandlerInterface &dhi) |
executes the command to create a new definition. | |
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the response object built by the execute command using the specified transmitter object | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
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 const string & | get_name () const |
return the name of this response object | |
Static Public Member Functions | |
static BESResponseHandler * | DefineResponseBuilder (string handler_name) |
Protected Attributes | |
string | _response_name |
BESResponseObject * | _response |
A request looks like:
define <def_name> as <container_list>
[where <container_x>.constraint="<constraint>"]
[,<container_x>.attributes="<attrs>"]
[aggregate by "<aggregation_command>"];
where container_list is a list of containers representing points of data, such as a file. For each container in the container_list the user can specify a constraint and a list of attributes. You need not specify a constraint for a given container or a list of attributes. If just specifying a constraint then leave out the attributes. If just specifying a list of attributes then leave out the constraint. For example:
define d1 as container_1,container_2
where container_1.constraint="constraint1"
,container_2.constraint="constraint2"
,container_2.attributes="attr1,attr2";
It adds the new definition to the list. If a definition already exists in the list with the given name then it is removed first and the new one is added. The definition is currently available through the life of the server process and is not persistent.
DefintionStorageList
|
|
|
|
|
|
|
dumps information about this object Displays the pointer value of this instance
Reimplemented from BESResponseHandler. |
|
executes the command to create a new definition. A BESDefine object is created and added to the list of definitions. If a definition already exists with the given name then it is removed and the new one added. The BESDefine object is created using the containers, constraints, attribute lists and aggregation command parsed in the parse method. The response object built for this command is a BESInfo response object. It will contain one of two possible responses:
Successfully added definition <def_name> If the keyword SILENT is set within the data handler interface then no information is added.
Implements BESResponseHandler. |
|
return the name of this response object This name is used to determine which response handler can handle a requested responose, such as das, dds, ddx, tab, info, version, help, etc...
|
|
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.
|
|
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.
|
|
transmit the response object built by the execute command using the specified transmitter object A BESInfo response object was built in the exeucte command to inform the user whether the definition was successfully added or replaced. The method send_text is called on the BESTransmitter object.
Implements BESResponseHandler. |
|
|
|
|