#include <TheBESKeys.h>
Inheritance diagram for TheBESKeys:
Public Types | |
typedef map< string, string >::const_iterator | Keys_citer |
Public Member Functions | |
string | keys_file_name () |
string | set_key (const string &key, const string &val) |
allows the user to set key/value pairs from within the application. | |
string | set_key (const string &pair) |
allows the user to set key/value pairs from within the application. | |
string | get_key (const string &s, bool &found) |
Retrieve the value of a given key, if set. | |
Keys_citer | keys_begin () |
Keys_citer | keys_end () |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
Static Public Member Functions | |
static BESKeys * | TheKeys () |
Static Public Attributes | |
static string | ConfigFile = "" |
Protected Member Functions | |
TheBESKeys (const string &keys_file_name) |
typedef map< string, string >::const_iterator BESKeys::Keys_citer [inherited] |
TheBESKeys::TheBESKeys | ( | const string & | keys_file_name | ) | [inline, protected] |
void BESKeys::dump | ( | ostream & | strm | ) | const [virtual, inherited] |
dumps information about this object
Displays the pointer value of this instance along with all of the keys.
strm | C++ i/o stream to dump the information to |
Implements BESObj.
string BESKeys::get_key | ( | const string & | s, | |
bool & | found | |||
) | [inherited] |
Retrieve the value of a given key, if set.
This method allows the user of BESKeys to retrieve the value of the specified key.
s | The key the user is looking for | |
found | Set 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. |
Keys_citer BESKeys::keys_begin | ( | ) | [inline, inherited] |
Keys_citer BESKeys::keys_end | ( | ) | [inline, inherited] |
string BESKeys::keys_file_name | ( | ) | [inline, inherited] |
string BESKeys::set_key | ( | const string & | pair | ) | [inherited] |
allows the user to set key/value pairs from within the application.
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.
pair | the key/value pair passed as key=value |
string BESKeys::set_key | ( | const string & | key, | |
const string & | val | |||
) | [inherited] |
allows the user to set key/value pairs from within the application.
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.
key | variable name that can be accessed using the get_key method | |
val | value of the variable returned when get_key is called for this key |
BESKeys * TheBESKeys::TheKeys | ( | ) | [static] |
string TheBESKeys::ConfigFile = "" [static] |