bes  Updated for version 3.17.0
TheBESKeys Class Reference
Inheritance diagram for TheBESKeys:
Inheritance graph

Public Types

typedef map< string, vector< string > >::const_iterator Keys_citer
 

Public Member Functions

virtual void dump (ostream &strm) const
 dumps information about this object More...
 
void get_value (const string &s, string &val, bool &found)
 Retrieve the value of a given key, if set. More...
 
void get_values (const string &s, vector< string > &vals, bool &found)
 Retrieve the values of a given key, if set. More...
 
Keys_citer keys_begin ()
 
Keys_citer keys_end ()
 
string keys_file_name ()
 
void set_key (const string &key, const string &val, bool addto=false)
 allows the user to set key/value pairs from within the application. More...
 
void set_key (const string &pair)
 allows the user to set key/value pairs from within the application. More...
 

Static Public Member Functions

static BESKeysTheKeys ()
 

Static Public Attributes

static string ConfigFile = ""
 

Protected Member Functions

 TheBESKeys (const string &keys_file_name)
 

Detailed Description

Definition at line 38 of file TheBESKeys.h.

Member Function Documentation

void BESKeys::dump ( ostream &  strm) const
virtualinherited

Displays the pointer value of this instance along with all of the keys.

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

Implements BESObj.

Definition at line 534 of file BESKeys.cc.

void BESKeys::get_value ( const string &  s,
string &  val,
bool &  found 
)
inherited

This method allows the user of BESKeys to retrieve the value of the specified key. If multiple values are set then an exception is thrown.

Parameters
sThe key the user is looking for
valThe value of the key the user is looking for
foundSet to true of the key is set or false if the key is not set. The value of a key can be set to the empty string, which is why this boolean is provided.
Exceptions
BESSyntaxUserErrorif multiple values are available for the specified key

Definition at line 481 of file BESKeys.cc.

void BESKeys::get_values ( const string &  s,
vector< string > &  vals,
bool &  found 
)
inherited

This method allows the user of BESKeys to retrieve the value of the specified key.

Parameters
sThe key the user is looking for
valsThe value set for the specified key
foundSet to true of the key is set or false if the key is not set. The value of a key can be set to the empty string, which is why this boolean is provided.

Definition at line 516 of file BESKeys.cc.

void BESKeys::set_key ( const string &  key,
const string &  val,
bool  addto = false 
)
inherited

This method allows users of BESKeys to set key/value pairs from within the application, such as for testing purposes, key/value pairs from the command line, etc...

If addto is set to true then the value is added to the list of values for key

If addto is false, and the key is already set then this value replaces all values for the key

Parameters
keyname of the key/value pair to be set
valvalue of the key to be set
addtoSpecifies whether to add the value to the key or set the value. Default is to set, not add to

Definition at line 430 of file BESKeys.cc.

void BESKeys::set_key ( const string &  pair)
inherited

This method allows users of BESKeys to set key/value pairs from within the application, such as for testing purposes, key/value pairs from the command line, etc...

If the key is already set then this value replaces the value currently held in the keys map.

Parameters
pairthe key/value pair passed as key=value

Definition at line 458 of file BESKeys.cc.

References BESKeys::set_key().

BESKeys * TheBESKeys::TheKeys ( )
static

Access to the singleton.

Definition at line 43 of file TheBESKeys.cc.

References ConfigFile.

Member Data Documentation

string TheBESKeys::ConfigFile = ""
static

TheBESKeys::ConfigFile provides a way for the daemon and test code to set the location of a particular configuration file.

Definition at line 53 of file TheBESKeys.h.


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