OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
ncml_module::NCMLCacheAggXMLCommand Class Reference

The BESXMLCommand for the command to recalculate the aggregation caches. More...

#include <NCMLCacheAggXMLCommand.h>

Inheritance diagram for ncml_module::NCMLCacheAggXMLCommand:
Inheritance graph
Collaboration diagram for ncml_module::NCMLCacheAggXMLCommand:
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 ()
 Has a response handler been created given the request document? More...
 
 NCMLCacheAggXMLCommand (const BESDataHandlerInterface &baseDHI)
 
virtual void parse_request (xmlNode *pNode)
 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 ~NCMLCacheAggXMLCommand ()
 

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...
 
static BESXMLCommandmakeInstance (const BESDataHandlerInterface &baseDHI)
 

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

BESDataHandlerInterface _dhi
 
string _str_cmd
 

Detailed Description

The BESXMLCommand for the command to recalculate the aggregation caches.

Note
This code is not currently used. jhrg 4/16/14

Definition at line 43 of file NCMLCacheAggXMLCommand.h.

Constructor & Destructor Documentation

ncml_module::NCMLCacheAggXMLCommand::NCMLCacheAggXMLCommand ( const BESDataHandlerInterface baseDHI)

Definition at line 43 of file NCMLCacheAggXMLCommand.cc.

Referenced by makeInstance().

ncml_module::NCMLCacheAggXMLCommand::~NCMLCacheAggXMLCommand ( )
virtual

Definition at line 49 of file NCMLCacheAggXMLCommand.cc.

Member Function Documentation

void BESXMLCommand::add_command ( const 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 79 of file BESXMLCommand.cc.

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

bool BESXMLCommand::del_command ( const 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 89 of file BESXMLCommand.cc.

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

void ncml_module::NCMLCacheAggXMLCommand::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 110 of file NCMLCacheAggXMLCommand.cc.

References BESXMLCommand::dump(), 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)
staticinherited

Find the BESXMLCommand creation function with the given name.

Parameters
cmd_strThe name of the command creation function to find

Definition at line 104 of file BESXMLCommand.cc.

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

virtual BESDataHandlerInterface& BESXMLCommand::get_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 87 of file BESXMLCommand.h.

References BESXMLCommand::_dhi.

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

bool ncml_module::NCMLCacheAggXMLCommand::has_response ( )
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 98 of file NCMLCacheAggXMLCommand.cc.

BESXMLCommand * ncml_module::NCMLCacheAggXMLCommand::makeInstance ( const BESDataHandlerInterface baseDHI)
static

Definition at line 120 of file NCMLCacheAggXMLCommand.cc.

References NCMLCacheAggXMLCommand().

Here is the call graph for this function:

void ncml_module::NCMLCacheAggXMLCommand::parse_request ( xmlNode *  node)
virtual
void ncml_module::NCMLCacheAggXMLCommand::prep_request ( )
virtual

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

Reimplemented from BESXMLCommand.

Definition at line 104 of file NCMLCacheAggXMLCommand.cc.

References BESDEBUG, and ncml_module::ModuleConstants::NCML_NAME.

Member Data Documentation


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