bes  Updated for version 3.19.1
BESXMLDeleteDefinitionCommand Class Reference
Inheritance diagram for BESXMLDeleteDefinitionCommand:
Inheritance graph

Public Member Functions

 BESXMLDeleteDefinitionCommand (const BESDataHandlerInterface &base_dhi)
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual BESDataHandlerInterfaceget_xmlcmd_dhi ()
 Return the current BESDataHandlerInterface. More...
 
virtual bool has_response ()
 Has a response handler been created given the request document? More...
 
virtual void parse_request (xmlNode *node)
 parse a delete definition command. More...
 
virtual void prep_request ()
 Prepare any information needed to execute the request of this 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 BESXMLCommandCommandBuilder (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 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
 

Detailed Description

Definition at line 39 of file BESXMLDeleteDefinitionCommand.h.

Member Function Documentation

◆ 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_strThe name of the command
cmdThe function to call to create the BESXMLCommand object

Definition at line 84 of file BESXMLCommand.cc.

◆ del_command()

bool BESXMLCommand::del_command ( const std::string &  cmd_str)
staticinherited

Deletes the command called cmd_str from the list of possible commands.

Parameters
cmd_strThe name of the command to remove from the list

Definition at line 94 of file BESXMLCommand.cc.

◆ dump()

void BESXMLDeleteDefinitionCommand::dump ( ostream &  strm) const
virtual

dumps information about this object

Displays the pointer value of this instance

Parameters
strmC++ i/o stream to dump the information to

Reimplemented from BESXMLCommand.

Definition at line 94 of file BESXMLDeleteDefinitionCommand.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_strThe name of the command creation function to find

Definition at line 109 of file BESXMLCommand.cc.

◆ get_xmlcmd_dhi()

virtual BESDataHandlerInterface& BESXMLCommand::get_xmlcmd_dhi ( )
inlinevirtualinherited

Return the current BESDataHandlerInterface.

Since there can be multiple commands within a single request document, different interface objects can be created. This returns the current interface object

Returns
The current BESDataHandlerInterface object

Reimplemented in BESXMLGetCommand.

Definition at line 103 of file BESXMLCommand.h.

◆ has_response()

virtual bool BESXMLDeleteDefinitionCommand::has_response ( )
inlinevirtual

Has a response handler been created given the request document?

Returns
true if a response handler has been set, false otherwise

Implements BESXMLCommand.

Definition at line 48 of file BESXMLDeleteDefinitionCommand.h.

◆ parse_request()

void BESXMLDeleteDefinitionCommand::parse_request ( xmlNode *  node)
virtual

parse a delete definition command.

<deleteDefinition name="definitionName" space="storeName" />

Parameters
nodexml2 element node pointer

Implements BESXMLCommand.

Definition at line 53 of file BESXMLDeleteDefinitionCommand.cc.

◆ prep_request()

virtual void BESXMLCommand::prep_request ( )
inlinevirtualinherited

Prepare any information needed to execute the request of this command.

Reimplemented in BESXMLDefineCommand, BESXMLGetCommand, and SampleSayXMLCommand.

Definition at line 90 of file BESXMLCommand.h.

◆ 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 60 of file BESXMLCommand.cc.

Member Data Documentation

◆ d_cmd_log_info

std::string BESXMLCommand::d_cmd_log_info
protectedinherited

Used only for the log.

Definition at line 62 of file BESXMLCommand.h.


The documentation for this class was generated from the following files: