bes  Updated for version 3.17.4
SampleSayXMLCommand Class Reference
Inheritance diagram for SampleSayXMLCommand:
Inheritance graph

Public Member Functions

virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual BESDataHandlerInterfaceget_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 show command. No properties or children elements More...
 
virtual void prep_request ()
 Prepare any information needed to execute the request of this command.
 
 SampleSayXMLCommand (const BESDataHandlerInterface &base_dhi)
 

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. More...
 
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. More...
 
static p_xmlcmd_builder find_command (const 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.
 

Protected Attributes

BESDataHandlerInterface _dhi
 
string _str_cmd
 

Detailed Description

Definition at line 39 of file SampleSayXMLCommand.h.

Member Function Documentation

◆ add_command()

void BESXMLCommand::add_command ( const string &  cmd_str,
p_xmlcmd_builder  cmd 
)
staticinherited

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 string &  cmd_str)
staticinherited
Parameters
cmd_strThe name of the command to remove from the list

Definition at line 94 of file BESXMLCommand.cc.

◆ dump()

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

Displays the pointer value of this instance

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

Reimplemented from BESXMLCommand.

Definition at line 115 of file SampleSayXMLCommand.cc.

References BESXMLCommand::dump().

◆ find_command()

p_xmlcmd_builder BESXMLCommand::find_command ( const string &  cmd_str)
staticinherited
Parameters
cmd_strThe name of the command creation function to find

Definition at line 109 of file BESXMLCommand.cc.

◆ get_dhi()

virtual BESDataHandlerInterface& BESXMLCommand::get_dhi ( )
inlinevirtualinherited

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

References BESXMLCommand::add_command(), BESXMLCommand::del_command(), BESXMLCommand::dump(), and BESXMLCommand::find_command().

◆ has_response()

virtual bool SampleSayXMLCommand::has_response ( )
inlinevirtual
Returns
true if a response handler has been set, false otherwise

Implements BESXMLCommand.

Definition at line 47 of file SampleSayXMLCommand.h.

References dump(), and prep_request().

◆ parse_request()

void SampleSayXMLCommand::parse_request ( xmlNode *  node)
virtual

<say what="what" to="whom">

Parameters
nodexml2 element node pointer

Implements BESXMLCommand.

Definition at line 52 of file SampleSayXMLCommand.cc.

References BESXMLUtils::GetFirstChild(), BESXMLUtils::GetNodeInfo(), and BESXMLCommand::set_response().


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