Trilinos_Util_Map Class Reference

#include <Trilinos_Util_CommandLineParser.h>

Inheritance diagram for Trilinos_Util_Map:

[legend]
List of all members.

Public Member Functions

 Trilinos_Util_Map ()
virtual ~Trilinos_Util_Map ()
Insertion/Removal methods.
virtual int Get (const string input, const int def_value)
 Gets the value of the specified option as an integer. If not found, returns the specified default value.
virtual double Get (const string input, const double def_value)
 Gets the value of the specified option as a double. If not found, returns the specified default value.
virtual string Get (const string input, const string def_value)
 Gets the value of the specified option as a string. If not found, returns the specified default value.
virtual bool Set (const string input, const char *value)
 Modify the value of a database entry.
virtual bool Set (const string input, const string value)
virtual bool Set (const string input, const int value)
virtual bool Set (const string input, const double value)
virtual bool Add (const string input, const string value)
 Add an entry to the databse.
bool SetLabel (string Label)
string GetLabel (string Label)
Query methods.
virtual bool Has (const string input)
 Check wheter an option is in the database or not.
Miscellaneous methods.
virtual void ShowAll () const
 Show all the databse entries.
virtual void ShowReallyAll () const
 Show all the databse entries, including entries beginning with "_".
virtual void Reset (void)

Friends

Friend functions .
ostream & operator<< (ostream &os, const Trilinos_Util_Map &S)

Constructor & Destructor Documentation

Trilinos_Util_Map::Trilinos_Util_Map  ) 
 

virtual Trilinos_Util_Map::~Trilinos_Util_Map  )  [inline, virtual]
 


Member Function Documentation

bool Trilinos_Util_Map::Add const string  input,
const string  value
[virtual]
 

Add an entry to the databse.

This method add an entry to the databse. First, it checks that this entry does not exist. If it exists, the method returns false. Otherwise, it adds the entry and returns true.

string Trilinos_Util_Map::Get const string  input,
const string  def_value
[virtual]
 

Gets the value of the specified option as a string. If not found, returns the specified default value.

double Trilinos_Util_Map::Get const string  input,
const double  def_value
[virtual]
 

Gets the value of the specified option as a double. If not found, returns the specified default value.

int Trilinos_Util_Map::Get const string  input,
const int  def_value
[virtual]
 

Gets the value of the specified option as an integer. If not found, returns the specified default value.

string Trilinos_Util_Map::GetLabel string  Label  )  [inline]
 

bool Trilinos_Util_Map::Has const string  input  )  [virtual]
 

Check wheter an option is in the database or not.

This method checks whether option input is in the databse or not. It returns true if it is, false otherwise.

void Trilinos_Util_Map::Reset void   )  [virtual]
 

bool Trilinos_Util_Map::Set const string  input,
const double  value
[virtual]
 

bool Trilinos_Util_Map::Set const string  input,
const int  value
[virtual]
 

bool Trilinos_Util_Map::Set const string  input,
const string  value
[virtual]
 

bool Trilinos_Util_Map::Set const string  input,
const char *  value
[virtual]
 

Modify the value of a database entry.

This method modifies the value of a database entry. If the entry does not exist in the database, return false. Otherwise, returns true.

bool Trilinos_Util_Map::SetLabel string  Label  )  [inline]
 

void Trilinos_Util_Map::ShowAll  )  const [virtual]
 

Show all the databse entries.

void Trilinos_Util_Map::ShowReallyAll  )  const [virtual]
 

Show all the databse entries, including entries beginning with "_".


Friends And Related Function Documentation

ostream& operator<< ostream &  os,
const Trilinos_Util_Map S
[friend]
 


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:42:11 2008 for TriUtils by doxygen 1.3.9.1