bes  Updated for version 3.20.6
BESContextManager Class Reference

maintains the list of registered request handlers for this server More...

#include <BESContextManager.h>

Collaboration diagram for BESContextManager:
Collaboration graph

Public Types

typedef std::map< std::string, std::string >::const_iterator Context_citer
 
typedef std::map< std::string, std::string >::iterator Context_iter
 

Public Member Functions

virtual void dump (std::ostream &strm) const
 dumps information about this object More...
 
virtual std::string get_context (const std::string &name, bool &found)
 retrieve the value of the specified context from the BES More...
 
virtual int get_context_int (const std::string &name, bool &found)
 Get the value of the given context and return it as an integer. More...
 
virtual void list_context (BESInfo &info)
 Adds all context and their values to the given informational object. More...
 
virtual void set_context (const std::string &name, const std::string &value)
 set context in the BES More...
 
virtual void unset_context (const std::string &name)
 set context in the BES More...
 

Static Public Member Functions

static BESContextManagerTheManager ()
 

Detailed Description

maintains the list of registered request handlers for this server

For a type of data to be handled by the BES the data type must registered a request handler with the server. This request handler knows how to fill in specific response objects, such as DAS, DDS, help, version, etc... The request handlers are registered with this request handler list.

Definition at line 50 of file BESContextManager.h.

Member Function Documentation

◆ dump()

void BESContextManager::dump ( std::ostream &  strm) const
virtual

dumps information about this object

Displays the pointer value of this instance along with information about each of the context values

Parameters
strmC++ i/o stream to dump the information to

Implements BESObj.

Definition at line 141 of file BESContextManager.cc.

◆ get_context()

string BESContextManager::get_context ( const std::string &  name,
bool &  found 
)
virtual

retrieve the value of the specified context from the BES

Finds the specified context and returns its value

Parameters
namename of the context to retrieve
foundthe value of this parameter is set to indicate whether the context was found or not. An empty string could be a valid value
Returns
the value of the requested context, empty string if not found

Definition at line 77 of file BESContextManager.cc.

◆ get_context_int()

int BESContextManager::get_context_int ( const std::string &  name,
bool &  found 
)
virtual

Get the value of the given context and return it as an integer.

Author
jhrg 5/30/18
Parameters
nameThe context name
foundTrue if the context was found, false otherwise.
Returns
The context value as an integer. Returns 0 and found == false if the context
  • name was not found. If the
  • name was found but the value is the empty string, return 0.

Definition at line 99 of file BESContextManager.cc.

◆ list_context()

void BESContextManager::list_context ( BESInfo info)
virtual

Adds all context and their values to the given informational object.

Definition at line 118 of file BESContextManager.cc.

◆ set_context()

void BESContextManager::set_context ( const std::string &  name,
const std::string &  value 
)
virtual

set context in the BES

Parameters
namename of the context
valuevalue the context is to take

Definition at line 53 of file BESContextManager.cc.

◆ unset_context()

void BESContextManager::unset_context ( const std::string &  name)
virtual

set context in the BES

Parameters
namename of the context
valuevalue the context is to take

Definition at line 63 of file BESContextManager.cc.


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