OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESXMLGetDataDDXCommand Class Reference

#include <BESXMLGetDataDDXCommand.h>

Inheritance diagram for BESXMLGetDataDDXCommand:
Inheritance graph
Collaboration diagram for BESXMLGetDataDDXCommand:
Collaboration graph

Public Member Functions

 BESXMLGetDataDDXCommand (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 dataddx command. More...
 
virtual void prep_request ()
 prepare the get dataddx command More...
 
virtual ~BESXMLGetDataDDXCommand ()
 

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

Protected Attributes

BESDataHandlerInterface _dhi
 
string _str_cmd
 

Detailed Description

Definition at line 39 of file BESXMLGetDataDDXCommand.h.

Constructor & Destructor Documentation

◆ BESXMLGetDataDDXCommand()

BESXMLGetDataDDXCommand::BESXMLGetDataDDXCommand ( const BESDataHandlerInterface base_dhi)

Definition at line 44 of file BESXMLGetDataDDXCommand.cc.

Referenced by CommandBuilder().

◆ ~BESXMLGetDataDDXCommand()

virtual BESXMLGetDataDDXCommand::~BESXMLGetDataDDXCommand ( )
inlinevirtual

Definition at line 46 of file BESXMLGetDataDDXCommand.h.

References CommandBuilder(), dump(), parse_request(), and prep_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 
)
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 85 of file BESXMLCommand.cc.

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

◆ CommandBuilder()

BESXMLCommand * BESXMLGetDataDDXCommand::CommandBuilder ( const BESDataHandlerInterface base_dhi)
static

Definition at line 162 of file BESXMLGetDataDDXCommand.cc.

References BESXMLGetDataDDXCommand().

Referenced by BESXMLDapCommandModule::initialize(), and ~BESXMLGetDataDDXCommand().

Here is the call graph for this function:

◆ del_command()

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

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

◆ dump()

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

Definition at line 152 of file BESXMLGetDataDDXCommand.cc.

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

Referenced by ~BESXMLGetDataDDXCommand().

Here is the call graph for this function:

◆ find_command()

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

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

◆ get_dhi()

BESDataHandlerInterface & BESXMLGetCommand::get_dhi ( )
virtualinherited

returns the BESDataHandlerInterface of either a sub command, if one exists, or this command's

Returns
BESDataHandlerInterface of sub command if it exists or this instances

Reimplemented from BESXMLCommand.

Definition at line 145 of file BESXMLGetCommand.cc.

References BESXMLCommand::_dhi, and BESXMLCommand::get_dhi().

Referenced by BESXMLGetCommand::~BESXMLGetCommand().

Here is the call graph for this function:

◆ has_response()

virtual bool BESXMLGetCommand::has_response ( )
inlinevirtualinherited

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 57 of file BESXMLGetCommand.h.

References BESXMLGetCommand::CommandBuilder(), BESXMLGetCommand::dump(), and BESXMLGetCommand::prep_request().

Here is the call graph for this function:

◆ parse_basic_get()

void BESXMLGetCommand::parse_basic_get ( xmlNode *  node,
const string &  name,
const string &  type,
const string &  value,
map< string, string > &  props 
)
protectedvirtualinherited

◆ parse_request()

void BESXMLGetDataDDXCommand::parse_request ( xmlNode *  node)
virtual

parse a get dataddx command.

>get type="dataddx" definition="d" returnAs="name" />

Parameters
nodexml2 element node pointer

Reimplemented from BESXMLGetCommand.

Definition at line 56 of file BESXMLGetDataDDXCommand.cc.

References BESXMLCommand::_str_cmd, DATADDX_SERVICE, GET_RESPONSE, BESXMLUtils::GetFirstChild(), BESXMLUtils::GetNextChild(), BESXMLUtils::GetNodeInfo(), BESXMLGetCommand::parse_basic_get(), and BESXMLCommand::set_response().

Referenced by ~BESXMLGetDataDDXCommand().

Here is the call graph for this function:

◆ prep_request()

void BESXMLGetDataDDXCommand::prep_request ( )
virtual

prepare the get dataddx command

set the contentStartId and mimeBoundary values in the data handler interface

Reimplemented from BESXMLGetCommand.

Definition at line 138 of file BESXMLGetDataDDXCommand.cc.

References BESXMLCommand::_dhi, BESDataHandlerInterface::data, DATADDX_BOUNDARY, DATADDX_STARTID, and BESXMLGetCommand::prep_request().

Referenced by ~BESXMLGetDataDDXCommand().

Here is the call graph for this function:

◆ set_response()

Member Data Documentation

◆ _dhi

◆ _str_cmd


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