Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

TheBESKeys Class Reference

#include <TheBESKeys.h>

Inheritance diagram for TheBESKeys:

[legend]
Collaboration diagram for TheBESKeys:
[legend]
List of all members.

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.
void show_keys ()
 displays all key/value pairs defined to standard output.
Keys_citer keys_begin ()
Keys_citer keys_end ()
virtual void dump (ostream &strm) const
 dumps information about this object

Static Public Member Functions

static BESKeysTheKeys ()

Static Public Attributes

static string ConfigFile = ""

Protected Member Functions

 TheBESKeys (const string &keys_file_name)

Member Typedef Documentation

typedef map< string, string >::const_iterator BESKeys::Keys_citer [inherited]
 


Constructor & Destructor Documentation

TheBESKeys::TheBESKeys const string &  keys_file_name  )  [inline, protected]
 


Member Function Documentation

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.

Parameters:
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.

Parameters:
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.
Returns:
Returns the value of the key, empty string if the key is not set.

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.

Parameters:
pair the key/value pair passed as key=value
Returns:
returns the value for the key, empty string if unsuccessful

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.

Parameters:
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
Returns:
returns the value of the key, empty string if unsuccessful

void BESKeys::show_keys  )  [inherited]
 

displays all key/value pairs defined to standard output.

This method allows the user to see all of the key/value pairs that are currently defined. The output looks like:

 key: "key", value: "value"
 

BESKeys * TheBESKeys::TheKeys  )  [static]
 


Member Data Documentation

string TheBESKeys::ConfigFile = "" [static]
 


The documentation for this class was generated from the following files:
Generated on Thu May 3 23:11:05 2007 for OPeNDAP Back End Server (BES) by  doxygen 1.4.4