copasi API  0.1
Public Types | Public Member Functions
SBMLReference Class Reference

#include <SBMLReference.h>

List of all members.

Public Types

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

Public Member Functions

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

Member Typedef Documentation

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

Constructor & Destructor Documentation

SBMLReference::SBMLReference ( )

Default constructor

SBMLReference::SBMLReference ( const SBMLReference src)

copy constructor

SBMLReference::~SBMLReference ( )

Default constructor


Member Function Documentation

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

Add an associated SBMLid, COPASIkey pair to the references.

Parameters:
conststd::string & id
conststd::string & key
Returns:
bool success
SBMLReference::const_iterator SBMLReference::beginCOPASIkey ( ) const
SBMLReference::const_iterator SBMLReference::beginSBMLid ( ) const
SBMLReference::const_iterator SBMLReference::endCOPASIkey ( ) const
SBMLReference::const_iterator SBMLReference::endSBMLid ( ) const
const std::string & SBMLReference::getCOPASIkey ( const std::string &  id) const

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

Parameters:
conststd::string & id
Returns:
const std::string & key ("" if no map is found)
const std::string & SBMLReference::getSBMLid ( const std::string &  key) const

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

Parameters:
conststd::string & key
Returns:
const std::string & id ("" if no map is found)
const std::string & SBMLReference::getURL ( ) const

Retrieve the URL of the referenced SBML file

Returns:
const std::string & url
bool SBMLReference::removeCOPASIkey ( const std::string &  key)

Remove the reference of the given key

Parameters:
conststd::string & key
Returns:
bool success
bool SBMLReference::removeSBMLid ( const std::string &  id)

Remove the reference of the given id

Parameters:
conststd::string & id
Returns:
bool success
bool SBMLReference::setURL ( const std::string &  url)

Set URL of the refernced SBML file.

Parameters:
conststd::string & id
Returns:
bool success

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines