CLayout Class Reference

#include <CLayout.h>

Inheritance diagram for CLayout:

List of all members.

Public Member Functions
	CLayout (const std::string &name="Layout", const CCopasiContainer *pParent=NULL)
	CLayout (const CLayout &src, const CCopasiContainer *pParent=NULL)
	CLayout (const Layout &sbml, std::map< std::string, std::string > &layoutmap, const CCopasiContainer *pParent=NULL)
	~CLayout ()
virtual const std::string &	getKey () const
const CLDimensions &	getDimensions () const
void	setDimensions (const CLDimensions &d)
const CCopasiVector < CLCompartmentGlyph > &	getListOfCompartmentGlyphs () const
void	addCompartmentGlyph (CLCompartmentGlyph *glyph)
const CCopasiVector < CLMetabGlyph > &	getListOfMetaboliteGlyphs () const
void	addMetaboliteGlyph (CLMetabGlyph *glyph)
const CCopasiVector < CLReactionGlyph > &	getListOfReactionGlyphs () const
void	addReactionGlyph (CLReactionGlyph *glyph)
const CCopasiVector < CLTextGlyph > &	getListOfTextGlyphs () const
void	addTextGlyph (CLTextGlyph *glyph)
const CCopasiVector < CLGraphicalObject > &	getListOfGraphicalObjects () const
void	addGraphicalObject (CLGraphicalObject *glyph)
virtual void	scale (const double &scaleFactor)
void	print (std::ostream *ostream) const
void	exportToDotFile (std::ostream &os) const
void	exportToSBML (Layout *layout, const std::map< CCopasiObject *, SBase * > &copasimodelmap, std::map< std::string, const SBase * > &sbmlIDs) const
Protected Member Functions
void	writeDotNode (std::ostream &os, const std::string &id, const std::string &label, int t=0) const
void	writeDotEdge (std::ostream &os, const std::string &id1, const std::string &id2, int t=0) const
Protected Attributes
std::string	mKey
CLDimensions	mDimensions
CCopasiVector< CLCompartmentGlyph >	mvCompartments
CCopasiVector< CLMetabGlyph >	mvMetabs
CCopasiVector< CLReactionGlyph >	mvReactions
CCopasiVector< CLTextGlyph >	mvLabels
CCopasiVector< CLGraphicalObject >	mvGraphicalObjects
Friends
std::ostream &	operator<< (std::ostream &os, const CLayout &g)

---

Detailed Description

This class describes a reaction network layout. Its structure is exactly corresponding to the sbml layout extension

---

Constructor & Destructor Documentation

CLayout::CLayout	(	const std::string &	name = "Layout",
		const CCopasiContainer *	pParent = NULL
	)

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

CLayout::CLayout	(	const Layout &	sbml,
		std::map< std::string, std::string > &	layoutmap,
		const CCopasiContainer *	pParent = NULL
	)

constructor from libsbml object. Does not read the whole libsbml tree. Additional work is done in SBMLDocumentLoader

CLayout::~CLayout

(

)

---

Member Function Documentation

void CLayout::addCompartmentGlyph

(

CLCompartmentGlyph *

glyph

)

add Glyph to layout. The layout takes ownership of the glyph.

void CLayout::addGraphicalObject

(

CLGraphicalObject *

glyph

)

add Glyph to layout. The layout takes ownership of the glyph.

void CLayout::addMetaboliteGlyph

(

CLMetabGlyph *

glyph

)

add Glyph to layout. The layout takes ownership of the glyph.

void CLayout::addReactionGlyph

(

CLReactionGlyph *

glyph

)

add Glyph to layout. The layout takes ownership of the glyph.

void CLayout::addTextGlyph

(

CLTextGlyph *

glyph

)

add Glyph to layout. The layout takes ownership of the glyph.

void CLayout::exportToDotFile

(

std::ostream &

os

)

const

void CLayout::exportToSBML	(	Layout *	layout,
		const std::map< CCopasiObject *, SBase * > &	copasimodelmap,
		std::map< std::string, const SBase * > &	sbmlIDs
	)		const

This method writes the information of the copasi layout object into the corresponding sbml object

const CLDimensions& CLayout::getDimensions

(

)

const [inline]

virtual const std::string& CLayout::getKey

(

)

const [inline, virtual]

Retrieves the key of the layout

Reimplemented from CCopasiObject.

const CCopasiVector<CLCompartmentGlyph>& CLayout::getListOfCompartmentGlyphs

(

)

const [inline]

const CCopasiVector<CLGraphicalObject>& CLayout::getListOfGraphicalObjects

(

)

const [inline]

const CCopasiVector<CLMetabGlyph>& CLayout::getListOfMetaboliteGlyphs

(

)

const [inline]

const CCopasiVector<CLReactionGlyph>& CLayout::getListOfReactionGlyphs

(

)

const [inline]

const CCopasiVector<CLTextGlyph>& CLayout::getListOfTextGlyphs

(

)

const [inline]

void CLayout::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 CCopasiObject.

virtual void CLayout::scale

(

const double &

scaleFactor

)

[inline, virtual]

void CLayout::setDimensions

(

const CLDimensions &

d

)

[inline]

void CLayout::writeDotEdge	(	std::ostream &	os,
		const std::string &	id1,
		const std::string &	id2,
		int	t = 0
	)		const [protected]

void CLayout::writeDotNode	(	std::ostream &	os,
		const std::string &	id,
		const std::string &	label,
		int	t = 0
	)		const [protected]

---

Friends And Related Function Documentation

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

insert operator

---

Member Data Documentation

CLDimensions CLayout::mDimensions [protected]

std::string CLayout::mKey [protected]

CCopasiVector<CLCompartmentGlyph> CLayout::mvCompartments [protected]

CCopasiVector<CLGraphicalObject> CLayout::mvGraphicalObjects [protected]

CCopasiVector<CLTextGlyph> CLayout::mvLabels [protected]

CCopasiVector<CLMetabGlyph> CLayout::mvMetabs [protected]

CCopasiVector<CLReactionGlyph> CLayout::mvReactions [protected]

---

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

• copasi/layout/CLayout.h
• copasi/layout/CLayout.cpp