Inheritance diagram for BESXMLDefineCommand:

Collaboration diagram for BESXMLDefineCommand:

Public Member Functions
	BESXMLDefineCommand (const BESDataHandlerInterface &base_dhi)

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

virtual BESDataHandlerInterface &	get_xmlcmd_dhi ()
	Return the current BESDataHandlerInterface.

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

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

virtual void	prep_request ()
	prepare the define command by making sure the containers exist

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	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 41 of file BESXMLDefineCommand.h.

Constructor & Destructor Documentation

◆ BESXMLDefineCommand()

BESXMLDefineCommand::BESXMLDefineCommand ( const BESDataHandlerInterface & base_dhi )

Definition at line 54 of file BESXMLDefineCommand.cc.

◆ ~BESXMLDefineCommand()

virtual BESXMLDefineCommand::~BESXMLDefineCommand ( )

inlinevirtual

Definition at line 68 of file BESXMLDefineCommand.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 * BESXMLDefineCommand::CommandBuilder ( const BESDataHandlerInterface & base_dhi )

static

Definition at line 427 of file BESXMLDefineCommand.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 BESXMLDefineCommand::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 BESXMLCommand.

Definition at line 418 of file BESXMLDefineCommand.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()

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

◆ has_response()

virtual bool BESXMLDefineCommand::has_response ( )

inlinevirtual

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 74 of file BESXMLDefineCommand.h.

◆ parse_request()

void BESXMLDefineCommand::parse_request ( xmlNode * node )

virtual

parse a define command.

<define name"d" space="default">
 
    <!-- required -->
    <container name="c"/>
 
    <!-- Optional -->
    <container name="c">
        <constraint> A valid DAP2 CE </constraint>
 
        <dap4constraint> ... </dap4constraint>
        <dap4function> ... </dap4function>
 
        <attributes> ... </attributes>
   </container>
 
</define>

Requires the name property. The space property is optional. Requires at least one container element. The container element requires the name property. The constraint and attribute elements of container are optional.

Parameters

node	xml2 element node pointer

Implements BESXMLCommand.

Definition at line 87 of file BESXMLDefineCommand.cc.

◆ prep_request()

void BESXMLDefineCommand::prep_request ( )

virtual

prepare the define command by making sure the containers exist

Todo: This could just as easily be done at the end of the parse_request() method. Unless we want to support the behavior that <define> could come before <setContainer> in the request document. That is, this method is called by XMLInterface::execute_data_request_plan(), after all the elements have been parsed. jhrg 2/11/18

Reimplemented from BESXMLCommand.

Definition at line 366 of file BESXMLDefineCommand.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

◆ BESXMLDefineCommand()

◆ ~BESXMLDefineCommand()

Member Function Documentation

◆ add_command()

◆ CommandBuilder()

◆ del_command()

◆ dump()

◆ find_command()

◆ get_xmlcmd_dhi()

◆ has_response()

◆ parse_request()

◆ prep_request()

◆ set_response()

Member Data Documentation

◆ d_cmd_log_info

◆ d_xmlcmd_dhi