Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes

BESXMLDeleteContainerCommand Class Reference

#include <BESXMLDeleteContainerCommand.h>

Inheritance diagram for BESXMLDeleteContainerCommand:
Inheritance graph
[legend]
Collaboration diagram for BESXMLDeleteContainerCommand:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 BESXMLDeleteContainerCommand (const BESDataHandlerInterface &base_dhi)
virtual void dump (ostream &strm) const
 dumps information about this object
virtual BESDataHandlerInterfaceget_dhi ()
 Return the current BESDataHandlerInterface.
virtual bool has_response ()
 Has a response handler been created given the request document?
virtual void parse_request (xmlNode *node)
 parse a show command.
virtual void prep_request ()
 Prepare any information needed to execute the request of this command.
virtual ~BESXMLDeleteContainerCommand ()

Static Public Member Functions

static void add_command (const string &cmd_str, p_xmlcmd_builder cmd)
 Add a command to the possible commands allowed by this BES.
static BESXMLCommandCommandBuilder (const BESDataHandlerInterface &base_dhi)
static bool del_command (const string &cmd_str)
 Deletes the command called cmd_str from the list of possible commands.
static p_xmlcmd_builder find_command (const string &cmd_str)
 Find the BESXMLCommand creation function with the given name.

Protected Member Functions

virtual void set_response ()
 The request has been parsed, use the command action name to set the response handler.

Protected Attributes

BESDataHandlerInterface _dhi
string _str_cmd

Detailed Description

Definition at line 39 of file BESXMLDeleteContainerCommand.h.


Constructor & Destructor Documentation

BESXMLDeleteContainerCommand::BESXMLDeleteContainerCommand ( const BESDataHandlerInterface base_dhi  ) 

Definition at line 42 of file BESXMLDeleteContainerCommand.cc.

Referenced by CommandBuilder().

virtual BESXMLDeleteContainerCommand::~BESXMLDeleteContainerCommand (  )  [inline, virtual]

Definition at line 43 of file BESXMLDeleteContainerCommand.h.


Member Function Documentation

void BESXMLCommand::add_command ( const string &  cmd_str,
p_xmlcmd_builder  cmd 
) [static, inherited]

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

Referenced by BESXMLDefaultCommands::initialize(), and BESXMLDapCommandModule::initialize().

BESXMLCommand * BESXMLDeleteContainerCommand::CommandBuilder ( const BESDataHandlerInterface base_dhi  )  [static]

Definition at line 111 of file BESXMLDeleteContainerCommand.cc.

References BESXMLDeleteContainerCommand().

Referenced by BESXMLDefaultCommands::initialize().

Here is the call graph for this function:

bool BESXMLCommand::del_command ( const string &  cmd_str  )  [static, inherited]

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

Referenced by BESXMLDefaultCommands::terminate(), and BESXMLDapCommandModule::terminate().

void BESXMLDeleteContainerCommand::dump ( 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 101 of file BESXMLDeleteContainerCommand.cc.

References BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Here is the call graph for this function:

p_xmlcmd_builder BESXMLCommand::find_command ( const string &  cmd_str  )  [static, inherited]

Find the BESXMLCommand creation function with the given name.

Parameters:
cmd_str The name of the command creation function to find

Definition at line 113 of file BESXMLCommand.cc.

Referenced by BESXMLInterface::build_data_request_plan(), and BESXMLGetCommand::parse_request().

virtual BESDataHandlerInterface& BESXMLCommand::get_dhi (  )  [inline, virtual, inherited]

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 87 of file BESXMLCommand.h.

References BESXMLCommand::_dhi.

Referenced by BESXMLInterface::build_data_request_plan(), BESXMLInterface::clean(), and BESXMLGetCommand::get_dhi().

virtual bool BESXMLDeleteContainerCommand::has_response (  )  [inline, virtual]

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 47 of file BESXMLDeleteContainerCommand.h.

void BESXMLDeleteContainerCommand::parse_request ( xmlNode *  node  )  [virtual]

parse a show command.

No properties or children elements

<deleteContainer name="containerName" space="storeName" />

Parameters:
node xml2 element node pointer

Implements BESXMLCommand.

Definition at line 54 of file BESXMLDeleteContainerCommand.cc.

References BESXMLCommand::_dhi, BESXMLCommand::_str_cmd, BESDataHandlerInterface::action, BESDataHandlerInterface::data, DELETE_CONTAINER_STR, BESXMLUtils::GetNodeInfo(), BESXMLCommand::set_response(), and STORE_NAME.

Here is the call graph for this function:

virtual void BESXMLCommand::prep_request (  )  [inline, virtual, inherited]

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

Reimplemented in BESXMLDefineCommand, BESXMLGetCommand, and BESXMLGetDataDDXCommand.

Definition at line 78 of file BESXMLCommand.h.

Referenced by BESXMLGetCommand::prep_request().

void BESXMLCommand::set_response (  )  [protected, virtual, inherited]

Member Data Documentation

string BESXMLCommand::_str_cmd [protected, inherited]

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