Inheritance diagram for BESXMLWWWGetCommand:

Collaboration diagram for BESXMLWWWGetCommand:

Public Member Functions
	BESXMLWWWGetCommand (const BESDataHandlerInterface &base_dhi)

virtual void	dump (std::ostream &strm) const
	dumps information about this object

virtual BESDataHandlerInterface &	get_xmlcmd_dhi ()
	returns the BESDataHandlerInterface of either a sub command, if one exists, or this command's

virtual bool	has_response ()
	Does this command return a response to the client?

virtual void	parse_request (xmlNode *node)
	parse a get html_form command.

virtual void	prep_request ()
	Prepare any information needed to execute the request of this get command.

Static Public Member Functions
static void	add_command (const std::string &cmd_str, p_xmlcmd_builder cmd)
	Add a command to the possible commands allowed by this BES.

static BESXMLCommand *	CommandBuilder (const BESDataHandlerInterface &base_dhi)

static void	del_command (const std::string &cmd_str)
	Deletes the command called cmd_str from the list of possible commands.

static p_xmlcmd_builder	find_command (const std::string &cmd_str)
	Find the BESXMLCommand creation function with the given name.

Protected Member Functions
virtual void	parse_basic_get (const std::string &type, std::map< std::string, std::string > &props)
	Extract information from the 'props' map.

virtual void	set_response ()
	The request has been parsed, use the command action name to set the response handler.

Protected Attributes
std::string	d_cmd_log_info
	Used only for the log.

BESDataHandlerInterface	d_xmlcmd_dhi

Detailed Description

Definition at line 39 of file BESXMLWWWGetCommand.h.

Constructor & Destructor Documentation

◆ BESXMLWWWGetCommand()

BESXMLWWWGetCommand::BESXMLWWWGetCommand ( const BESDataHandlerInterface & base_dhi )

Definition at line 52 of file BESXMLWWWGetCommand.cc.

◆ ~BESXMLWWWGetCommand()

virtual BESXMLWWWGetCommand::~BESXMLWWWGetCommand ( )

inlinevirtual

Definition at line 42 of file BESXMLWWWGetCommand.h.

Member Function Documentation

◆ add_command()

void BESXMLCommand::add_command	(	const std::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_str	The name of the command
cmd	The function to call to create the BESXMLCommand object

Definition at line 88 of file BESXMLCommand.cc.

◆ CommandBuilder()

BESXMLCommand * BESXMLWWWGetCommand::CommandBuilder ( const BESDataHandlerInterface & base_dhi )

static

Definition at line 111 of file BESXMLWWWGetCommand.cc.

◆ del_command()

void BESXMLCommand::del_command ( const std::string & cmd_str )

staticinherited

Deletes the command called cmd_str from the list of possible commands.

Parameters

cmd_str The name of the command to remove from the list

Definition at line 98 of file BESXMLCommand.cc.

◆ dump()

void BESXMLWWWGetCommand::dump ( std::ostream & strm ) const

virtual

dumps information about this object

Displays the pointer value of this instance

Parameters

strm	C++ i/o stream to dump the information to

Reimplemented from BESXMLGetCommand.

Definition at line 102 of file BESXMLWWWGetCommand.cc.

◆ find_command()

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

staticinherited

Find the BESXMLCommand creation function with the given name.

Parameters

cmd_str The name of the command creation function to find

Definition at line 110 of file BESXMLCommand.cc.

◆ get_xmlcmd_dhi()

BESDataHandlerInterface & BESXMLGetCommand::get_xmlcmd_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 172 of file BESXMLGetCommand.cc.

◆ has_response()

virtual bool BESXMLGetCommand::has_response ( )

inlinevirtualinherited

Does this command return a response to the client?

Every command has an associated ResponseHandler, but not all ResponseHandlers return information to the BES's client. In fact, for any group of commands sent to the BES, only one can return information (except for errors, which stop command processing). If this command does not normally return a response (text or binary data), the value of this method should be false.

Returns: true if it returns a response, false otherwise

Implements BESXMLCommand.

Definition at line 59 of file BESXMLGetCommand.h.

◆ parse_basic_get()

void BESXMLGetCommand::parse_basic_get	(	const std::string &	type,
		std::map< std::string, std::string > &	props )

protectedvirtualinherited

Extract information from the 'props' map.

Extract the values for various properties from the whole command file and load them into this command's DHI 'data' map or the specific 'definition' or 'space' values. As a side effect, build the cmd_log_info string (used to record information about this command in the BES log.

Parameters

type	The thing to get (e.g., dds)
props	Holds the definition, space, returnAs, etc., values to be used with when running the command.

Definition at line 127 of file BESXMLGetCommand.cc.

◆ parse_request()

void BESXMLWWWGetCommand::parse_request ( xmlNode * node )

virtual

parse a get html_form command.

Parameters

node	xml2 element node pointer

Reimplemented from BESXMLGetCommand.

Definition at line 63 of file BESXMLWWWGetCommand.cc.

◆ prep_request()

void BESXMLGetCommand::prep_request ( )

virtualinherited

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

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 186 of file BESXMLGetCommand.cc.

◆ set_response()

void BESXMLCommand::set_response ( )

protectedvirtualinherited

The request has been parsed, use the command action name to set the response handler.

Definition at line 65 of file BESXMLCommand.cc.

Member Data Documentation

◆ d_cmd_log_info

std::string BESXMLCommand::d_cmd_log_info

protectedinherited

Used only for the log.

Definition at line 75 of file BESXMLCommand.h.

◆ d_xmlcmd_dhi

BESDataHandlerInterface BESXMLCommand::d_xmlcmd_dhi

protectedinherited

Definition at line 71 of file BESXMLCommand.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BESXMLWWWGetCommand()

◆ ~BESXMLWWWGetCommand()

Member Function Documentation

◆ add_command()

◆ CommandBuilder()

◆ del_command()

◆ dump()

◆ find_command()

◆ get_xmlcmd_dhi()

◆ has_response()

◆ parse_basic_get()

◆ parse_request()

◆ prep_request()

◆ set_response()

Member Data Documentation

◆ d_cmd_log_info

◆ d_xmlcmd_dhi