|
virtual void | set_response () |
| The request has been parsed, use the command action name to set the response handler.
|
|
Definition at line 41 of file BESXMLDefineCommand.h.
◆ BESXMLDefineCommand()
◆ ~BESXMLDefineCommand()
virtual BESXMLDefineCommand::~BESXMLDefineCommand |
( |
| ) |
|
|
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 BESXMLDefineCommand::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 BESXMLCommand.
Definition at line 418 of file BESXMLDefineCommand.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 BESXMLDefineCommand::has_response |
( |
| ) |
|
|
inlinevirtual |
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 74 of file BESXMLDefineCommand.h.
◆ parse_request()
void BESXMLDefineCommand::parse_request |
( |
xmlNode * |
node | ) |
|
|
virtual |
parse a define command.
<define name"d" space="default">
<container name="c"/>
<container name="c">
<constraint> A valid DAP2 CE </constraint>
<dap4constraint> ... </dap4constraint>
<dap4function> ... </dap4function>
<attributes> ... </attributes>
</container>
</define>
Requires the name property. The space property is optional. Requires at least one container element. The container element requires the name property. The constraint and attribute elements of container are optional.
- Parameters
-
node | xml2 element node pointer |
Implements BESXMLCommand.
Definition at line 87 of file BESXMLDefineCommand.cc.
◆ prep_request()
void BESXMLDefineCommand::prep_request |
( |
| ) |
|
|
virtual |
prepare the define command by making sure the containers exist
- Todo:
- This could just as easily be done at the end of the parse_request() method. Unless we want to support the behavior that <define> could come before <setContainer> in the request document. That is, this method is called by XMLInterface::execute_data_request_plan(), after all the elements have been parsed. jhrg 2/11/18
Reimplemented from BESXMLCommand.
Definition at line 366 of file BESXMLDefineCommand.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: