StandAloneClient Class Reference

StandAloneClient is an object that handles the connection to, sending requests to, and receiving response from a specified OpenDAP server running either on this machine or another machine. More...

#include <StandAloneClient.h>

Inheritance diagram for StandAloneClient:
Inheritance graph
[legend]
Collaboration diagram for StandAloneClient:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual void dump (ostream &strm) const
 dumps information about this object
void executeClientCommand (const string &cmd)
 Executes a client side command.
void executeCommands (ifstream &inputFile, int repeat)
 Sends the xml request document from the specified file to the server.
void executeCommands (const string &cmd_list, int repeat)
 Send the command(s) specified to the BES server after wrapping in request document.
void interact ()
 An interactive BES client that takes BES requests on the command line.
void setOutput (ostream *strm, bool created)
 Set the output stream for responses from the BES server.
 StandAloneClient ()
 ~StandAloneClient ()

Detailed Description

StandAloneClient is an object that handles the connection to, sending requests to, and receiving response from a specified OpenDAP server running either on this machine or another machine.

Requests to the OpenDAP server can be taken in different ways by the StandAloneClient object.

Response from the requests can sent to any File or OutputStream as specified by using the setOutput methods. If no output is specified using the setOutput methods thent he output is ignored.

Thread safety of this object has not yet been determined.

Author:
Patrick West <A * HREF="mailto:pwest@hao.ucar.edu">pwest@hao.ucar.edu

Definition at line 73 of file StandAloneClient.h.


Constructor & Destructor Documentation

StandAloneClient::StandAloneClient (  )  [inline]

Definition at line 85 of file StandAloneClient.h.

StandAloneClient::~StandAloneClient (  ) 

Definition at line 88 of file StandAloneClient.cc.


Member Function Documentation

void StandAloneClient::dump ( 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

Implements BESObj.

Definition at line 521 of file StandAloneClient.cc.

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

Referenced by StandAloneApp::dump().

Here is the call graph for this function:

void StandAloneClient::executeClientCommand ( const string &  cmd  ) 

Executes a client side command.

Client side commands include client suppress; client output to screen; client output to <filename>; client load <filename>;

Parameters:
cmd The BES client side command to execute
See also:
BESError

Definition at line 140 of file StandAloneClient.cc.

References executeCommands(), and setOutput().

Here is the call graph for this function:

void StandAloneClient::executeCommands ( ifstream &  istrm,
int  repeat 
)

Sends the xml request document from the specified file to the server.

The requests do not have to be one per line but can span multiple lines and there can be more than one command per line.

The response is written to the output stream if one is specified, otherwise the output is ignored.

Parameters:
istrm The file holding the xml request document
repeat Number of times to repeat the series of commands from the file.
Exceptions:
BESError Thrown if there is a problem opening the file to read, reading the request document from the file, sending the request document to the server or a problem receiving any of the responses from the server.
See also:
File
BESError

Definition at line 353 of file StandAloneClient.cc.

void StandAloneClient::executeCommands ( const string &  cmd_list,
int  repeat 
)

Send the command(s) specified to the BES server after wrapping in request document.

This takes a command or set of commands from the command line, wraps it in the proper request document, and sends it to the server.

The response is written to the output stream if one is specified, otherwise the output is ignored.

Parameters:
cmd The BES commands to send to the BES server
repeat Number of times to repeat the command
Exceptions:
BESError Thrown if there is a problem sending any of the request to the server or a problem receiving any of the responses from the server.
See also:
BESError

Definition at line 310 of file StandAloneClient.cc.

References CmdTranslation::set_show(), and CmdTranslation::translate().

Referenced by executeClientCommand(), and StandAloneApp::run().

Here is the call graph for this function:

void StandAloneClient::interact (  ) 

An interactive BES client that takes BES requests on the command line.

There can be more than one command per line, but commands cannot span multiple lines. The user will be prompted to enter a new BES request.

OpenDAPClient:

The response is written to the output stream if one is specified, otherwise the output is ignored.

Exceptions:
BESError Thrown if there is a problem sending any of the requests to the server or a problem receiving any of the responses from the server.
See also:
BESError

Definition at line 389 of file StandAloneClient.cc.

References CmdTranslation::set_show(), and CmdTranslation::translate().

Referenced by StandAloneApp::run().

Here is the call graph for this function:

void StandAloneClient::setOutput ( ostream *  strm,
bool  created 
)

Set the output stream for responses from the BES server.

Specify where the response output from your BES request will be sent. Set to null if you wish to ignore the response from the BES server.

Parameters:
strm an OutputStream specifying where to send responses from the BES server. If null then the output will not be output but will be thrown away.
created true of the passed stream was created and can be deleted either by being replaced ro in the destructor
Exceptions:
BESError catches any problems with opening or writing to the output stream and creates a BESError
See also:
OutputStream
BESError

Definition at line 116 of file StandAloneClient.cc.

Referenced by executeClientCommand(), and StandAloneApp::run().


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

Generated on 18 Feb 2010 for OPeNDAP Hyrax Back End Server (BES) by  doxygen 1.6.1