bes  Updated for version 3.17.0
BESXMLGetCommand Class Reference
Inheritance diagram for BESXMLGetCommand:
Inheritance graph

Public Member Functions

 BESXMLGetCommand (const BESDataHandlerInterface &base_dhi)
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual BESDataHandlerInterfaceget_dhi ()
 returns the BESDataHandlerInterface of either a sub command, if one exists, or this command's More...
 
virtual bool has_response ()
 Has a response handler been created given the request document? More...
 
virtual void parse_request (xmlNode *node)
 parse a get command. More...
 
virtual void prep_request ()
 Prepare any information needed to execute the request of this get command. More...
 

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 parse_basic_get (xmlNode *node, const string &name, const string &type, const string &value, map< string, string > &props)
 
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 BESXMLGetCommand.h.

Member Function Documentation

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.

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.

void BESXMLGetCommand::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.

Reimplemented in BESXMLGetDataDDXCommand.

Definition at line 192 of file BESXMLGetCommand.cc.

References BESXMLCommand::dump().

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.

BESDataHandlerInterface & BESXMLGetCommand::get_dhi ( )
virtual
Returns
BESDataHandlerInterface of sub command if it exists or this instances

Reimplemented from BESXMLCommand.

Definition at line 136 of file BESXMLGetCommand.cc.

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

Implements BESXMLCommand.

Definition at line 56 of file BESXMLGetCommand.h.

References dump(), and prep_request().

void BESXMLGetCommand::parse_request ( xmlNode *  node)
virtual

<get type="dds" definition="d" returnAs="name" />

Parameters
nodexml2 element node pointer

Implements BESXMLCommand.

Reimplemented in BESXMLGetDataDDXCommand.

Definition at line 56 of file BESXMLGetCommand.cc.

References BESDataHandlerInterface::action, BESDataHandlerInterface::data, BESXMLCommand::find_command(), BESXMLUtils::GetNodeInfo(), BESUtil::lowercase(), and BESXMLCommand::set_response().

void BESXMLGetCommand::prep_request ( )
virtual

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.

Reimplemented in BESXMLGetDataDDXCommand.

Definition at line 150 of file BESXMLGetCommand.cc.

References BESDataHandlerInterface::data, BESDefinitionStorageList::find_persistence(), BESDefinitionStorageList::look_for(), and BESDefinitionStorage::look_for().


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