VariableMap Class Reference

#include <VariableMap.h>

Public Member Functions
	VariableMap ()
	The Standard constructor.
	~VariableMap ()
	The Standard destructor.
void	AddVariable (const std::string &varname, const Variant &val)
Variant	RetrieveValue (const std::string &varname)
bool	Exists (const std::string &varname)
void	Erase (const std::string &varname)
void	DumpValues ()
void	Destroy ()

Detailed Description

This is the primary structure for holding variables: the variable map It is an STL map that takes a string-based variable name and stores a variant. Every instance of an Evaluator has one private local VariableMap that cannot be accessed by other Evaluators, and there is on global VariableMap that is shared between Evaluators.

Definition at line 42 of file VariableMap.h.

Constructor & Destructor Documentation

VariableMap()

VariableMap::VariableMap

(

)

The Standard constructor.

Definition at line 46 of file VariableMap.cpp.

{
    //cout << "Creating variable map\n";
    //Initiate anything necessary here.
}

~VariableMap()

VariableMap::~VariableMap

(

)

The Standard destructor.

Definition at line 53 of file VariableMap.cpp.

{
 
    //cout << "Deleting variablemap\n";
    //cout << "contains " << mVariableMap.size() << " values\n";
    //DumpValues();
    //Delete mVariableMap if necessary.
    //Erase things by hand, for debugging's sake
    //    std::map<std::string, Variant>::iterator i = mVariableMap.begin();
 
   // while(i !=  mVariableMap.end())
   //     {
   //        i = mVariableMap.begin();
   //        mVariableMap.erase(i);
   //     }
    mVariableMap.clear();
 
}

Member Function Documentation

AddVariable()

void VariableMap::AddVariable	(	const std::string &	varname,
		const Variant &	val
	)

This method will add a new variable with name varname and value val to the variable map, or (if it already exists) change its value to val.

Definition at line 84 of file VariableMap.cpp.

{
    string tmpVarName = PEBLUtility::ToUpper(varname);
 
    map<string, Variant>::iterator p;
 
    p = mVariableMap.find(tmpVarName);
 
    //If the variable is in there already, change its value
 
    if(p!=mVariableMap.end())
        {
 
            p->second = val;
        }
    else
        {
            //variable isn't there yet, so add the new value into map
            mVariableMap.insert(pair<string, Variant>(tmpVarName, val));
        }
 
} 

References PEBLUtility::ToUpper().

Referenced by Evaluator::Evaluate(), Evaluator::Evaluate1(), extra(), PlatformWindow::Initialize(), PEventLoop::Loop(), PEventLoop::Loop1(), main(), main(), PEBLInterpret(), PlatformEventQueue::Prime(), and PlatformWindow::Resize().

Destroy()

void VariableMap::Destroy

(

)

Definition at line 73 of file VariableMap.cpp.

{
    mVariableMap.clear();
}

Referenced by CaptureSignal(), and PEBLInterpret().

DumpValues()

void VariableMap::DumpValues

(

)

This method is primarily for debugging purposes. It will iterate through the entire variable map, and Display each of the values held in the map.

Definition at line 162 of file VariableMap.cpp.

{
    map<string,Variant>::iterator p;
  
    for(p= mVariableMap.begin(); p!=mVariableMap.end(); p++)
        {
            cout << "VariableName:  [" << p->first << ":"<< (p->first).length() << "] | Value: [" << p->second << "]\n";   
        }
  
}

Referenced by extra(), and main().

Erase()

void VariableMap::Erase

(

const std::string &

varname

)

This will erase the value stored in varname

Definition at line 150 of file VariableMap.cpp.

{
    string tmpVarname = PEBLUtility::ToUpper(varname);
    mVariableMap.erase(tmpVarname);
}

References PEBLUtility::ToUpper().

Referenced by extra().

Exists()

bool VariableMap::Exists

(

const std::string &

varname

)

Definition at line 138 of file VariableMap.cpp.

{
    string tmpVarName = PEBLUtility::ToUpper(varname);
    map<string,Variant>::iterator p = mVariableMap.find(tmpVarName);
    if(p == mVariableMap.end())
        return false;
    else
        return true;
}

References PEBLUtility::ToUpper().

Referenced by PlatformWindow::Initialize(), and Evaluator::IsVariableName().

RetrieveValue()

Variant VariableMap::RetrieveValue

(

const std::string &

varname

)

This method will retrieve the value designated by varname. If varname doesn't exist, it will return 0, along with a warning.

Definition at line 113 of file VariableMap.cpp.

{
 
    map<string,Variant>::iterator p;
  
    //Get a the variable 
    string tmpVarName = PEBLUtility::ToUpper(varname);
    
    p = mVariableMap.find(tmpVarName);
 
    if(p == mVariableMap.end())
        {
            string message = "Trying to use an undefined variable:  " + string(varname);
            PError::SignalFatalError(message);
            return Variant(0);  //This really won't happen.
        }
    else
        {
            Variant vt = p->second;
            return vt;
        }
}

References PError::SignalFatalError(), and PEBLUtility::ToUpper().

Referenced by Evaluator::Evaluate(), Evaluator::Evaluate(), Evaluator::Evaluate1(), Evaluator::Evaluate1(), extra(), PlatformWindow::Initialize(), PEventLoop::Loop(), main(), PEBLObjects::MakeTextBox(), PEBLObjects::MakeWindow(), and PlatformWindow::Resize().

---

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

• VariableMap.h
• VariableMap.cpp