|
virtual void | parse_basic_get (const std::string &type, std::map< std::string, std::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...
|
|
Definition at line 39 of file BESXMLWWWGetCommand.h.
◆ BESXMLWWWGetCommand()
◆ ~BESXMLWWWGetCommand()
virtual BESXMLWWWGetCommand::~BESXMLWWWGetCommand |
( |
| ) |
|
|
inlinevirtual |
◆ add_command()
void BESXMLCommand::add_command |
( |
const std::string & |
cmd_str, |
|
|
p_xmlcmd_builder |
cmd |
|
) |
| |
|
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.
- Parameters
-
cmd_str | The name of the command |
cmd | The function to call to create the BESXMLCommand object |
Definition at line 88 of file BESXMLCommand.cc.
◆ CommandBuilder()
◆ del_command()
void BESXMLCommand::del_command |
( |
const std::string & |
cmd_str | ) |
|
|
staticinherited |
Deletes the command called cmd_str from the list of possible commands.
- Parameters
-
cmd_str | The name of the command to remove from the list |
Definition at line 98 of file BESXMLCommand.cc.
◆ dump()
void BESXMLWWWGetCommand::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 BESXMLGetCommand.
Definition at line 102 of file BESXMLWWWGetCommand.cc.
◆ find_command()
p_xmlcmd_builder BESXMLCommand::find_command |
( |
const std::string & |
cmd_str | ) |
|
|
staticinherited |
Find the BESXMLCommand creation function with the given name.
- Parameters
-
cmd_str | The name of the command creation function to find |
Definition at line 110 of file BESXMLCommand.cc.
◆ get_xmlcmd_dhi()
◆ has_response()
virtual bool BESXMLGetCommand::has_response |
( |
| ) |
|
|
inlinevirtualinherited |
Does this command return a response to the client?
Every command has an associated ResponseHandler, but not all ResponseHandlers return information to the BES's client. In fact, for any group of commands sent to the BES, only one can return information (except for errors, which stop command processing). If this command does not normally return a response (text or binary data), the value of this method should be false.
- Returns
- true if it returns a response, false otherwise
Implements BESXMLCommand.
Definition at line 59 of file BESXMLGetCommand.h.
◆ parse_basic_get()
void BESXMLGetCommand::parse_basic_get |
( |
const std::string & |
type, |
|
|
std::map< std::string, std::string > & |
props |
|
) |
| |
|
protectedvirtualinherited |
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.
- Parameters
-
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.
◆ parse_request()
void BESXMLWWWGetCommand::parse_request |
( |
xmlNode * |
node | ) |
|
|
virtual |
parse a get html_form command.
<get type="dds" definition="d" url="url">
- Parameters
-
node | xml2 element node pointer |
Reimplemented from BESXMLGetCommand.
Definition at line 63 of file BESXMLWWWGetCommand.cc.
◆ prep_request()
void BESXMLGetCommand::prep_request |
( |
| ) |
|
|
virtualinherited |
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.
◆ set_response()
void BESXMLCommand::set_response |
( |
| ) |
|
|
protectedvirtualinherited |
The request has been parsed, use the command action name to set the response handler.
Definition at line 65 of file BESXMLCommand.cc.
◆ d_cmd_log_info
std::string BESXMLCommand::d_cmd_log_info |
|
protectedinherited |
◆ d_xmlcmd_dhi
The documentation for this class was generated from the following files: