SBMLReference Class Reference

#include <SBMLReference.h>

Collaboration diagram for SBMLReference:

Public Types
typedef std::map< std::string, std::string >::const_iterator	const_iterator

Public Member Functions
bool	add (const std::string &id, const std::string &key)
const_iterator	beginCOPASIkey () const
const_iterator	beginSBMLid () const
const_iterator	endCOPASIkey () const
const_iterator	endSBMLid () const
const std::string &	getCOPASIkey (const std::string &id) const
const std::string &	getSBMLid (const std::string &key) const
const std::string &	getURL () const
bool	removeCOPASIkey (const std::string &key)
bool	removeSBMLid (const std::string &id)
	SBMLReference ()
	SBMLReference (const SBMLReference &src)
bool	setURL (const std::string &url)
	~SBMLReference ()

Private Attributes
std::map< std::string, std::string >	mIdToKey
std::map< std::string, std::string >	mKeyToId
std::string	mURL

Static Private Attributes
static std::string	NotFound = ""

Detailed Description

Definition at line 19 of file SBMLReference.h.

Member Typedef Documentation

typedef std::map<std::string, std::string>::const_iterator SBMLReference::const_iterator

Definition at line 22 of file SBMLReference.h.

Constructor & Destructor Documentation

SBMLReference::SBMLReference

(

)

Default constructor

Definition at line 19 of file SBMLReference.cpp.

                            :
    mURL(""),
    mIdToKey(),
    mKeyToId()
{}

SBMLReference::SBMLReference

(

const SBMLReference &

src

)

copy constructor

Definition at line 25 of file SBMLReference.cpp.

                                                     :
    mURL(src.mURL),
    mIdToKey(src.mIdToKey),
    mKeyToId(src.mKeyToId)
{}

SBMLReference::~SBMLReference

(

)

Default constructor

Definition at line 31 of file SBMLReference.cpp.

{}

Member Function Documentation

bool SBMLReference::add	(	const std::string &	id,
		const std::string &	key
	)

Add an associated SBMLid, COPASIkey pair to the references.

Parameters

const	std::string & id
const	std::string & key

Returns

bool success

Definition at line 61 of file SBMLReference.cpp.

References mIdToKey, and mKeyToId.

{
  if (mIdToKey.find(id) != mIdToKey.end() ||
      mKeyToId.find(key) != mKeyToId.end()) return false;

  mIdToKey[id] = key;
  mKeyToId[key] = id;

  return true;
}

SBMLReference::const_iterator SBMLReference::beginCOPASIkey

(

)

const

Definition at line 105 of file SBMLReference.cpp.

References mKeyToId.

{return mKeyToId.begin();}

SBMLReference::const_iterator SBMLReference::beginSBMLid

(

)

const

Definition at line 111 of file SBMLReference.cpp.

References mIdToKey.

  {return mIdToKey.begin();}

SBMLReference::const_iterator SBMLReference::endCOPASIkey

(

)

const

Definition at line 108 of file SBMLReference.cpp.

References mKeyToId.

  {return mKeyToId.end();}

SBMLReference::const_iterator SBMLReference::endSBMLid

(

)

const

Definition at line 114 of file SBMLReference.cpp.

References mIdToKey.

  {return mIdToKey.end();}

const std::string & SBMLReference::getCOPASIkey

(

const std::string &

id

)

const

Retrieve the COPASI key which is mapped to the given SBML Id.

Parameters

const

std::string & id

Returns

const std::string & key ("" if no map is found)

Definition at line 52 of file SBMLReference.cpp.

References mIdToKey, and NotFound.

  {
    const_iterator it = mIdToKey.find(id);
    if (it != mIdToKey.end())
      return it->second;
    else
      return NotFound;
  }

const std::string & SBMLReference::getSBMLid

(

const std::string &

key

)

const

Retrieve the SBML Id which is mapped to the given COPASI key.

Parameters

const

std::string & key

Returns

const std::string & id ("" if no map is found)

Definition at line 43 of file SBMLReference.cpp.

References mKeyToId, and NotFound.

  {
    const_iterator it = mKeyToId.find(key);
    if (it != mKeyToId.end())
      return it->second;
    else
      return NotFound;
  }

const std::string & SBMLReference::getURL

(

)

const

Retrieve the URL of the referenced SBML file

Returns

const std::string & url

Definition at line 40 of file SBMLReference.cpp.

References mURL.

  {return mURL;}

bool SBMLReference::removeCOPASIkey

(

const std::string &

key

)

Remove the reference of the given key

Parameters

const

std::string & key

Returns

bool success

Definition at line 88 of file SBMLReference.cpp.

References mIdToKey, and mKeyToId.

{
  std::map<std::string, std::string>::iterator itKey = mKeyToId.find(key);

  if (itKey == mKeyToId.end()) return false;

  std::map<std::string, std::string>::iterator itId = mIdToKey.find(itKey->second);

  mKeyToId.erase(itKey);

  if (itId == mIdToKey.end()) return false;

  mIdToKey.erase(itId);

  return true;
}

bool SBMLReference::removeSBMLid

(

const std::string &

id

)

Remove the reference of the given id

Parameters

const

std::string & id

Returns

bool success

Definition at line 72 of file SBMLReference.cpp.

References mIdToKey, and mKeyToId.

{
  std::map<std::string, std::string>::iterator itId = mIdToKey.find(id);
  if (itId == mIdToKey.end()) return false;

  std::map<std::string, std::string>::iterator itKey = mKeyToId.find(itId->second);

  mIdToKey.erase(itId);

  if (itKey == mKeyToId.end()) return false;

  mKeyToId.erase(itKey);

  return true;
}

bool SBMLReference::setURL

(

const std::string &

url

)

Set URL of the refernced SBML file.

Parameters

const

std::string & id

Returns

bool success

Definition at line 34 of file SBMLReference.cpp.

References mURL.

{
  mURL = url;
  return true;
}

Member Data Documentation

std::map<std::string, std::string> SBMLReference::mIdToKey

private

Definition at line 120 of file SBMLReference.h.

Referenced by add(), beginSBMLid(), endSBMLid(), getCOPASIkey(), removeCOPASIkey(), and removeSBMLid().

std::map<std::string, std::string> SBMLReference::mKeyToId

private

Definition at line 125 of file SBMLReference.h.

Referenced by add(), beginCOPASIkey(), endCOPASIkey(), getSBMLid(), removeCOPASIkey(), and removeSBMLid().

std::string SBMLReference::mURL

private

Definition at line 115 of file SBMLReference.h.

Referenced by getURL(), and setURL().

std::string SBMLReference::NotFound = ""

staticprivate

Definition at line 127 of file SBMLReference.h.

Referenced by getCOPASIkey(), and getSBMLid().

---

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

• SBMLReference.h
• SBMLReference.cpp