SBMLReference Class Reference

#include <SBMLReference.h>

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 = ""

Member Typedef Documentation

const_iterator

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

Constructor & Destructor Documentation

SBMLReference() [1/2]

SBMLReference::SBMLReference

(

)

Default constructor

SBMLReference() [2/2]

SBMLReference::SBMLReference

(

const SBMLReference &

src

)

copy constructor

~SBMLReference()

SBMLReference::~SBMLReference

(

)

Default constructor

Member Function Documentation

add()

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

References mIdToKey, and mKeyToId.

beginCOPASIkey()

SBMLReference::const_iterator SBMLReference::beginCOPASIkey

(

)

const

References mKeyToId.

beginSBMLid()

SBMLReference::const_iterator SBMLReference::beginSBMLid

(

)

const

References mIdToKey.

endCOPASIkey()

SBMLReference::const_iterator SBMLReference::endCOPASIkey

(

)

const

References mKeyToId.

endSBMLid()

SBMLReference::const_iterator SBMLReference::endSBMLid

(

)

const

References mIdToKey.

getCOPASIkey()

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)

References mIdToKey, and NotFound.

getSBMLid()

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)

References mKeyToId, and NotFound.

getURL()

const std::string & SBMLReference::getURL

(

)

const

Retrieve the URL of the referenced SBML file

Returns

const std::string & url

References mURL.

removeCOPASIkey()

bool SBMLReference::removeCOPASIkey

(

const std::string &

key

)

Remove the reference of the given key

Parameters

const

std::string & key

Returns

bool success

References mIdToKey, and mKeyToId.

removeSBMLid()

bool SBMLReference::removeSBMLid

(

const std::string &

id

)

Remove the reference of the given id

Parameters

const

std::string & id

Returns

bool success

References mIdToKey, and mKeyToId.

setURL()

bool SBMLReference::setURL

(

const std::string &

url

)

Set URL of the refernced SBML file.

Parameters

const

std::string & id

Returns

bool success

References mURL.

Member Data Documentation

mIdToKey

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

private

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

mKeyToId

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

private

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

mURL

std::string SBMLReference::mURL

private

Referenced by getURL(), and setURL().

NotFound

std::string SBMLReference::NotFound = ""

staticprivate

Referenced by getCOPASIkey(), and getSBMLid().

---

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

• SBMLReference.h
• SBMLReference.cpp