bes
Updated for version 3.19.1
|
Public Member Functions | |
BESXMLGetCommand (const BESDataHandlerInterface &base_dhi) | |
virtual void | dump (ostream &strm) const |
dumps information about this object More... | |
virtual BESDataHandlerInterface & | get_xmlcmd_dhi () |
returns the BESDataHandlerInterface of either a sub command, if one exists, or this command's More... | |
virtual bool | has_response () |
Has a response handler been created given the request document? More... | |
virtual void | parse_request (xmlNode *node) |
parse a get command. More... | |
virtual void | prep_request () |
Prepare any information needed to execute the request of this get command. More... | |
Static Public Member Functions | |
static void | add_command (const std::string &cmd_str, p_xmlcmd_builder cmd) |
Add a command to the possible commands allowed by this BES. More... | |
static BESXMLCommand * | CommandBuilder (const BESDataHandlerInterface &base_dhi) |
static bool | del_command (const std::string &cmd_str) |
Deletes the command called cmd_str from the list of possible commands. More... | |
static p_xmlcmd_builder | find_command (const std::string &cmd_str) |
Find the BESXMLCommand creation function with the given name. More... | |
Protected Member Functions | |
virtual void | parse_basic_get (const string &type, map< string, string > &props) |
Extract information from the 'props' map. More... | |
virtual void | set_response () |
The request has been parsed, use the command action name to set the response handler. More... | |
Protected Attributes | |
std::string | d_cmd_log_info |
Used only for the log. More... | |
BESDataHandlerInterface | d_xmlcmd_dhi |
Definition at line 41 of file BESXMLGetCommand.h.
|
staticinherited |
Add a command to the possible commands allowed by this BES.
This adds a function to parse a specific BES command within the BES request document using the given name. If a command element is found with the name cmd_str, then the XMLCommand object is created using the passed cmd object.
cmd_str | The name of the command |
cmd | The function to call to create the BESXMLCommand object |
Definition at line 84 of file BESXMLCommand.cc.
|
staticinherited |
Deletes the command called cmd_str from the list of possible commands.
cmd_str | The name of the command to remove from the list |
Definition at line 94 of file BESXMLCommand.cc.
|
virtual |
dumps information about this object
Displays the pointer value of this instance
strm | C++ i/o stream to dump the information to |
Reimplemented from BESXMLCommand.
Definition at line 225 of file BESXMLGetCommand.cc.
|
staticinherited |
Find the BESXMLCommand creation function with the given name.
cmd_str | The name of the command creation function to find |
Definition at line 109 of file BESXMLCommand.cc.
|
virtual |
returns the BESDataHandlerInterface of either a sub command, if one exists, or this command's
Reimplemented from BESXMLCommand.
Definition at line 169 of file BESXMLGetCommand.cc.
|
inlinevirtual |
Has a response handler been created given the request document?
Implements BESXMLCommand.
Definition at line 59 of file BESXMLGetCommand.h.
|
protectedvirtual |
Extract information from the 'props' map.
Extract the values for various properties from the whole command file and load them into this command's DHI 'data' map or the specific 'definition' or 'space' values. As a side effect, build the cmd_log_info string (used to record information about this command in the BES log.
name | Always 'get' FIXME Remove this |
type | The thing to get (e.g., dds) |
props | Holds the definition, space, returnAs, etc., values to be used with when running the command. |
Definition at line 127 of file BESXMLGetCommand.cc.
|
virtual |
parse a get
command.
The get
commands have the form:
get type="dds" definition="d" returnAs="name"
and return the returnAs
item derived from the type
object for the data referenced by the definition
.
node | xml2 element node pointer |
Implements BESXMLCommand.
Definition at line 70 of file BESXMLGetCommand.cc.
|
virtual |
Prepare any information needed to execute the request of this get command.
This function is used to prepare the information needed to execute the get request. It finds the definition specified in the element and prepares all of the containers within that definition.
Reimplemented from BESXMLCommand.
Definition at line 183 of file BESXMLGetCommand.cc.
|
protectedvirtualinherited |
The request has been parsed, use the command action name to set the response handler.
Definition at line 60 of file BESXMLCommand.cc.
|
protectedinherited |
Used only for the log.
Definition at line 62 of file BESXMLCommand.h.