OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESXMLCommand Class Referenceabstract

#include <BESXMLCommand.h>

Inheritance diagram for BESXMLCommand:
Inheritance graph
Collaboration diagram for BESXMLCommand:
Collaboration 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 ()=0
 Has a response handler been created given the request document? More...
 
virtual void parse_request (xmlNode *node)=0
 Parse the XML request document begining at the given node. More...
 
virtual void prep_request ()
 Prepare any information needed to execute the request of this command. More...
 
virtual ~BESXMLCommand ()
 

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 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

 BESXMLCommand (const BESDataHandlerInterface &base_dhi)
 Creates a BESXMLCommand document given a base data handler interface object. More...
 
virtual void set_response ()
 The request has been parsed, use the command action name to set the response handler. More...
 

Protected Attributes

BESDataHandlerInterface _dhi
 
string _str_cmd
 

Detailed Description

Definition at line 51 of file BESXMLCommand.h.

Constructor & Destructor Documentation

◆ BESXMLCommand()

BESXMLCommand::BESXMLCommand ( const BESDataHandlerInterface base_dhi)
protected

Creates a BESXMLCommand document given a base data handler interface object.

Since there can be multiple commands within a single BES request document, there can be multiple data handler interface objects created. Use the one passed as the base interface handler object

Definition at line 48 of file BESXMLCommand.cc.

References _dhi, and BESDataHandlerInterface::make_copy().

Here is the call graph for this function:

◆ ~BESXMLCommand()

virtual BESXMLCommand::~BESXMLCommand ( )
inlinevirtual

Definition at line 62 of file BESXMLCommand.h.

References has_response(), and parse_request().

Here is the call graph for this function:

Member Function Documentation

◆ add_command()

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

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

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

◆ del_command()

bool BESXMLCommand::del_command ( const string &  cmd_str)
static

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

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

◆ dump()

◆ find_command()

p_xmlcmd_builder BESXMLCommand::find_command ( const string &  cmd_str)
static

Find the BESXMLCommand creation function with the given name.

Parameters
cmd_strThe name of the command creation function to find

Definition at line 113 of file BESXMLCommand.cc.

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

◆ get_dhi()

virtual BESDataHandlerInterface& BESXMLCommand::get_dhi ( )
inlinevirtual

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 _dhi, add_command(), del_command(), dump(), and find_command().

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

Here is the call graph for this function:

◆ has_response()

virtual bool BESXMLCommand::has_response ( )
pure virtual

◆ parse_request()

virtual void BESXMLCommand::parse_request ( xmlNode *  node)
pure virtual

◆ prep_request()

virtual void BESXMLCommand::prep_request ( )
inlinevirtual

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().

◆ set_response()

Member Data Documentation

◆ _dhi

◆ _str_cmd


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