#include <CLReactionGlyph.h>

Inheritance diagram for CLMetabReferenceGlyph:

Public Types
enum	Role { UNDEFINED, SUBSTRATE, PRODUCT, SIDESUBSTRATE, SIDEPRODUCT, MODIFIER, ACTIVATOR, INHIBITOR }
Public Member Functions
	CLMetabReferenceGlyph (const std::string &name="MetabReferenceGlyph", const CCopasiContainer *pParent=NULL)
	CLMetabReferenceGlyph (const CLMetabReferenceGlyph &src, const CCopasiContainer *pParent=NULL)
	CLMetabReferenceGlyph (const SpeciesReferenceGlyph &sbml, const std::map< std::string, std::string > &modelmap, std::map< std::string, std::string > &layoutmap, const CCopasiContainer *pParent=NULL)
CLMetabReferenceGlyph &	operator= (const CLMetabReferenceGlyph &rhs)
const std::string &	getMetabGlyphKey () const
CLMetabGlyph *	getMetabGlyph () const
void	setMetabGlyphKey (const std::string &k)
const CLCurve &	getCurve () const
CLCurve &	getCurve ()
void	setCurve (const CLCurve &c)
Role	getRole () const
void	setRole (Role r)
const std::string &	getRoleDisplayName () const
virtual void	exportToSBML (SpeciesReferenceGlyph g, const std::map< CCopasiObject , SBase * > &copasimodelmap, std::map< std::string, const SBase * > &sbmlIDs, const std::map< const CLBase , const SBase > &layoutmap) const
void	print (std::ostream *ostream) const
Static Public Attributes
static const std::string	RoleName []
static const std::string	XMLRole []
Friends
std::ostream &	operator<< (std::ostream &os, const CLMetabReferenceGlyph &g)

Detailed Description

Graphical representation of a CChemEqElement. This correspondents to the sbml SpeciesReferenceGlyph. The copasi equivalent is the CChemEqElement, however it has no key, so it cannot be referred to.

Member Enumeration Documentation

enum CLMetabReferenceGlyph::Role

Enum type for the role of the metab reference This enum must be synchronized with the corresponding enum in libsbml (sbml/layout/SpeciesReferenceRole.h)

Enumerator:

UNDEFINED
SUBSTRATE
PRODUCT
SIDESUBSTRATE
SIDEPRODUCT
MODIFIER
ACTIVATOR
INHIBITOR

Constructor & Destructor Documentation

CLMetabReferenceGlyph::CLMetabReferenceGlyph	(	const std::string &	name = `"MetabReferenceGlyph"`,
		const CCopasiContainer *	pParent = `NULL`
	)

CLMetabReferenceGlyph::CLMetabReferenceGlyph	(	const CLMetabReferenceGlyph &	src,
		const CCopasiContainer *	pParent = `NULL`
	)

CLMetabReferenceGlyph::CLMetabReferenceGlyph	(	const SpeciesReferenceGlyph &	sbml,
		const std::map< std::string, std::string > &	modelmap,
		std::map< std::string, std::string > &	layoutmap,
		const CCopasiContainer *	pParent = `NULL`
	)

constructor from libsbml object

Member Function Documentation

void CLMetabReferenceGlyph::exportToSBML	(	SpeciesReferenceGlyph *	g,
		const std::map< CCopasiObject , SBase > &	copasimodelmap,
		std::map< std::string, const SBase * > &	sbmlIDs,
		const std::map< const CLBase , const SBase > &	layoutmap
	)		const `[virtual]`

This method writes the information of the copasi layout object into the corresponding sbml object layoutmap contains a map from copasi layout objects to libsbml layout objects. this is needed for resolving the reference to the metab glyph.

const CLCurve& CLMetabReferenceGlyph::getCurve ( ) const [inline]

CLCurve& CLMetabReferenceGlyph::getCurve ( ) [inline]

CLMetabGlyph * CLMetabReferenceGlyph::getMetabGlyph ( ) const

const std::string& CLMetabReferenceGlyph::getMetabGlyphKey ( ) const [inline]

Role CLMetabReferenceGlyph::getRole ( ) const [inline]

const std::string& CLMetabReferenceGlyph::getRoleDisplayName ( ) const [inline]

CLMetabReferenceGlyph & CLMetabReferenceGlyph::operator= ( const CLMetabReferenceGlyph & rhs )

assignment operator.

void CLMetabReferenceGlyph::print ( std::ostream * ostream ) const [virtual]

This is the output method for any object. The default implementation provided with CCopasiObject uses the ostream operator<< of the object to print the object.To override this default behavior one needs to reimplement the virtual print function.

Parameters:

std::ostream * ostream

Reimplemented from CLGraphicalObject.

void CLMetabReferenceGlyph::setCurve ( const CLCurve & c ) [inline]

void CLMetabReferenceGlyph::setMetabGlyphKey ( const std::string & k ) [inline]

void CLMetabReferenceGlyph::setRole ( Role r ) [inline]

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const CLMetabReferenceGlyph &	g
	)		`[friend]`

insert operator

Member Data Documentation

const std::string CLMetabReferenceGlyph::RoleName [static]

Initial value:

  {
    "undefined role",
    "substrate",
    "product",
    "side substrate",
    "side product",
    "modifier",
    "activator",
    "inhibitor"
    ""
  }

String literals for the GUI to display the role of a metab reference

const std::string CLMetabReferenceGlyph::XMLRole [static]

Initial value:

  {
    "undefinedRole",
    "substrate",
    "product",
    "sideSubstrate",
    "sideProduct",
    "modifier",
    "activator",
    "inhibitor",
    ""
  }

XML type names of the roles. This is used in the xml importer and exporter

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

copasi/layout/CLReactionGlyph.h
copasi/layout/CLReactionGlyph.cpp

Public Types

Public Member Functions