#include <CKeyFactory.h>

Collaboration diagram for CKeyFactory:

Classes
class	CDecisionVector

class	HashTable

Public Member Functions
std::string	add (const std::string &prefix, CCopasiObject *pObject)

bool	addFix (const std::string &key, CCopasiObject *pObject)

	CKeyFactory ()

CCopasiObject *	get (const std::string &key)

bool	remove (const std::string &key)

	~CKeyFactory ()

Static Public Member Functions
static bool	isValidKey (const std::string &key, const std::string &prefix="")

Protected Attributes
std::map< std::string, HashTable >	mKeyTable

Static Protected Attributes
static CDecisionVector	isDigit

static CDecisionVector	isPrefix

Detailed Description

Definition at line 35 of file CKeyFactory.h.

Constructor & Destructor Documentation

CKeyFactory::CKeyFactory ( )

Default constructor

Definition at line 161 of file CKeyFactory.cpp.

                         :
     mKeyTable()
 {}

CKeyFactory::~CKeyFactory ( )

Destructor

Definition at line 165 of file CKeyFactory.cpp.

165 {}

Member Function Documentation

std::string CKeyFactory::add	(	const std::string &	prefix,
		CCopasiObject *	pObject
	)

Add an object with a key generated from the given prefix to the key map. The return value is the actually generated key.

Parameters

const	std::string & prefix
CCopasiObject	* pObject

Returns: std::string key

Definition at line 167 of file CKeyFactory.cpp.

References mKeyTable.

Referenced by CCompartment::CCompartment(), CEvent::CEvent(), CFunction::CFunction(), CLColorDefinition::CLColorDefinition(), CLEllipse::CLEllipse(), CLGlobalRenderInformation::CLGlobalRenderInformation(), CLGlobalStyle::CLGlobalStyle(), CLGradientStop::CLGradientStop(), CLGroup::CLGroup(), CLImage::CLImage(), CLLinearGradient::CLLinearGradient(), CLLineEnding::CLLineEnding(), CLLocalRenderInformation::CLLocalRenderInformation(), CLLocalStyle::CLLocalStyle(), CLPolygon::CLPolygon(), CLRadialGradient::CLRadialGradient(), CLRectangle::CLRectangle(), CLRenderCurve::CLRenderCurve(), CLText::CLText(), CMetab::CMetab(), CModelEntity::CModelEntity(), CReaction::CReaction(), CExperiment::initializeParameter(), and CModel::initObjects().

 {
   std::map< std::string, CKeyFactory::HashTable >::iterator it =
     mKeyTable.find(prefix);
 
   if (it == mKeyTable.end())
     {
       std::pair<std::map< std::string, CKeyFactory::HashTable >::iterator, bool> ret =
         mKeyTable.insert(std::map< std::string, CKeyFactory::HashTable >::value_type(prefix, CKeyFactory::HashTable()));
 
       it = ret.first;
     }
 
   std::stringstream key;
   key << prefix + "_" << it->second.add(pObject);
 
   return key.str();
 }

bool CKeyFactory::addFix	(	const std::string &	key,
		CCopasiObject *	pObject
	)

Add an object with a fix given key. The return value indicate whether the key was actually inserted.

Parameters

const	std::string & key
CCopasiObject	* pObject

Returns: bool success

Definition at line 187 of file CKeyFactory.cpp.

References isDigit, and mKeyTable.

Referenced by CCopasiXMLParser::ModelParameterSetElement::start().

 {
   size_t pos = key.length() - 1;
 
   while (isDigit(key[pos]) && pos) --pos;
 
   std::string Prefix = key.substr(0, pos);
   size_t index = atoi(key.substr(pos + 1).c_str());
 
   std::map< std::string, CKeyFactory::HashTable >::iterator it =
     mKeyTable.find(Prefix);
 
   if (it == mKeyTable.end())
     {
       std::pair<std::map< std::string, CKeyFactory::HashTable >::iterator, bool> ret =
         mKeyTable.insert(std::map< std::string, CKeyFactory::HashTable >::value_type(Prefix, CKeyFactory::HashTable()));
 
       it = ret.first;
     }
 
   return it->second.addFix(index, pObject);
 }

CCopasiObject * CKeyFactory::get ( const std::string & key )

Retrieve the object referred by key from the key map.

Parameters

const std::string & key

Returns: CCopasiObject * pObject

Definition at line 235 of file CKeyFactory.cpp.

References isDigit, and mKeyTable.

 {
   if (key.length() == 0) return NULL;
 
   size_t pos = key.length() - 1; //TODO !!!pos can be invalid (-1); not anymore, but look for other errors like this
 
   while (isDigit(key[pos]) && pos) --pos;
 
   std::string Prefix = key.substr(0, pos);
   size_t index = atoi(key.substr(pos + 1).c_str());
 
   std::map< std::string, CKeyFactory::HashTable >::iterator it =
     mKeyTable.find(Prefix);
 
   if (it == mKeyTable.end()) return NULL;
 
   return it->second.get(index);
 }

bool CKeyFactory::isValidKey	(	const std::string &	key,
		const std::string &	prefix = `""`
	)

static

check whether the key is valid

Parameters

const	std::string & key
const	std::string & prefix (default: check for [_a-zA-Z]+_+)

Returns: bool isValid

CKeyFactory class. This class is used to create a unique key whithin COPASI. It also allows retreival of the CCopasiObject the key is assigned to.

Created for Copasi by Stefan Hoops 2003 Copyright Stefan Hoops

Definition at line 30 of file CKeyFactory.cpp.

References isDigit, and isPrefix.

Referenced by CCopasiParameter::isValidValue(), and CCopasiXMLParser::ParameterElement::start().

 {
   if (key == "" && prefix == "") return true;
 
   size_t digitsStart = key.length() - 1;
 
   while (isDigit(key[digitsStart]) && digitsStart) --digitsStart;
 
   if (digitsStart < 1 || digitsStart > key.length() - 2 || key[digitsStart] != '_') return false;
 
   if (prefix != "")
     {
       if (prefix != key.substr(0, digitsStart)) return false;
       else return true;
     }
 
   size_t prefixEnd = 0;
 
   while (isPrefix(key[prefixEnd]) && prefixEnd < digitsStart) ++prefixEnd;
 
   return (prefixEnd == digitsStart);
 }

bool CKeyFactory::remove ( const std::string & key )

Remove the key and the related object from the key map.

Parameters

const std::string & key

Returns: bool success

Definition at line 210 of file CKeyFactory.cpp.

References isDigit, and mKeyTable.

Referenced by COutputDefinitionVector::cleanup(), CReportDefinitionVector::cleanup(), CReportDefinition::cleanup(), CExperiment::initializeParameter(), CAnnotation::~CAnnotation(), CBiologicalDescription::~CBiologicalDescription(), CCompartment::~CCompartment(), CCopasiParameter::~CCopasiParameter(), CCopasiTask::~CCopasiTask(), CCreator::~CCreator(), CEvent::~CEvent(), CFunction::~CFunction(), CFunctionParameter::~CFunctionParameter(), CLayout::~CLayout(), CLColorDefinition::~CLColorDefinition(), CLEllipse::~CLEllipse(), CLGradientBase::~CLGradientBase(), CLGraphicalObject::~CLGraphicalObject(), CLGroup::~CLGroup(), CLImage::~CLImage(), CListOfLayouts::~CListOfLayouts(), CLPolygon::~CLPolygon(), CLRectangle::~CLRectangle(), CLRenderCurve::~CLRenderCurve(), CLRenderInformationBase::~CLRenderInformationBase(), CLStyle::~CLStyle(), CLText::~CLText(), CMetab::~CMetab(), CModel::~CModel(), CModelParameterSet::~CModelParameterSet(), CModification::~CModification(), CMoiety::~CMoiety(), CReaction::~CReaction(), CReference::~CReference(), and CSlider::~CSlider().

 {
   size_t pos = key.length();
 
   if (pos == 0) return false;
 
   --pos;
 
   while (isDigit(key[pos]) && pos) --pos;
 
   std::string Prefix = key.substr(0, pos);
 
   size_t index = 0;
 
   if (pos + 1 < key.length())
     index = atoi(key.substr(pos + 1).c_str());
 
   std::map< std::string, CKeyFactory::HashTable >::iterator it =
     mKeyTable.find(Prefix);
 
   if (it == mKeyTable.end()) return false;
 
   return it->second.remove(index);
 }