#include <CListOfLayouts.h>

Inheritance diagram for CListOfLayouts:

Public Member Functions
void	addGlobalRenderInformation (CLGlobalRenderInformation *pRenderInfo)

void	addLayout (CLayout *layout, const std::map< std::string, std::string > &m)

	CListOfLayouts (const std::string &name="ListOfLayouts", const CDataContainer *pParent=NULL)

void	exportToSBML (ListOf lol, std::map< const CDataObject , SBase * > &copasimodelmap, const std::map< std::string, const SBase * > &idMap, unsigned int level, unsigned int version) const

const std::string &	getKey ()

CDataVector< CLGlobalRenderInformation > &	getListOfGlobalRenderInformationObjects ()

const CDataVector< CLGlobalRenderInformation > &	getListOfGlobalRenderInformationObjects () const

CLGlobalRenderInformation *	getRenderInformation (size_t index)

const CLGlobalRenderInformation *	getRenderInformation (size_t index) const

	~CListOfLayouts ()

Public Member Functions inherited from CDataVectorN< CLayout >
virtual bool	add (CDataObject *pObject, const bool &adopt=true)

virtual bool	add (const CLayout &src)

virtual bool	applyData (const CData &data, CUndoData::CChangeSet &changes)

	CDataVectorN (const CDataVectorN< CLayout > &src, const CDataContainer *pParent)

	CDataVectorN (const std::string &name="NoName", const CDataContainer *pParent=NO_PARENT)

virtual void	createUndoData (CUndoData &undoData, const CUndoData::Type &, const CData &oldData=CData(), const CCore::Framework &framework=CCore::Framework::ParticleNumbers) const

void	createUniqueName (std::string &name) const

virtual size_t	getIndex (const std::string &name) const

virtual const CObjectInterface *	getObject (const CCommonName &name) const

CDataVectorN< CLayout > &	operator= (const std::vector< CLayout * > &rhs)

CLayout &	operator[] (const size_t &index)

const CLayout &	operator[] (const size_t &index) const

CLayout &	operator[] (const std::string &name)

const CLayout &	operator[] (const std::string &name) const

virtual void	remove (const std::string &name)

virtual CData	toData () const

virtual	~CDataVectorN ()

Public Member Functions inherited from CDataVector< CType >
virtual bool	add (const CType &src)

iterator	begin ()

const_iterator	begin () const

name_iterator	beginName ()

const_name_iterator	beginName () const

	CDataVector (const CDataVector< CType > &src, const CDataContainer *pParent)

	CDataVector (const std::string &name="NoName", const CDataContainer *pParent=NO_PARENT, const CFlags< Flag > &flag=CFlags< Flag >::None)

virtual void	cleanup ()

virtual void	clear ()

void	deepCopy (const CDataVector< CType > &source)

virtual bool	empty () const

iterator	end ()

const_iterator	end () const

name_iterator	endName ()

const_name_iterator	endName () const

virtual size_t	getIndex (const CDataObject *pObject) const

virtual CUndoObjectInterface *	insert (const CData &data)

bool	operator!= (const CDataVector< CType > &rhs)

CDataVector< CType > &	operator= (const CDataVector< CType > &rhs)

CDataVector< CType > &	operator= (const std::vector< CType * > &rhs)

CType &	operator[] (const size_t &index)

const CType &	operator[] (const size_t &index) const

virtual bool	remove (CDataObject *pObject)

virtual void	remove (const size_t &index)

virtual void	resize (const size_t &newSize)

virtual size_t	size () const

virtual void	swap (const size_t &indexFrom, const size_t &indexTo)

virtual void	updateIndex (const size_t &index, const CUndoObjectInterface *pUndoObject)

virtual	~CDataVector ()

Public Member Functions inherited from CDataContainer
virtual bool	appendDeletedDependentData (CUndoData &undoData) const

	CDataContainer (const CDataContainer &src, const CDataContainer *pParent)

	CDataContainer (const std::string &name, const CDataContainer *pParent=NO_PARENT, const std::string &type="CN", const CFlags< Flag > &flag=CFlags< Flag >::None)

virtual std::string	getChildObjectUnits (const CDataObject *pObject) const

void	getDescendants (CDataObject::DataObjectSet &descendants, const bool &recursive=false) const

virtual objectMap &	getObjects ()

virtual const objectMap &	getObjects () const

virtual const std::string	getUnits () const override

virtual const CDataObject *	getValueObject () const override

void	objectRenamed (CDataObject *pObject, const std::string &oldName)

virtual	~CDataContainer ()

Public Member Functions inherited from CDataObject
void	addIssue (const CIssue &issue)

void	addReference (const CDataContainer *pReference)

virtual void	calculateValue () override

	CDataObject (const CDataObject &src, const CDataContainer *pParent=NULL)

virtual void	destruct () override

virtual CCommonName	getCN () const override

virtual const CDataObject *	getDataObject () const override

virtual const std::string &	getKey () const

CDataContainer *	getObjectAncestor (const std::string &type) const

CDataModel *	getObjectDataModel () const

virtual std::string	getObjectDisplayName () const override

const CObjectInterface *	getObjectFromCN (const CCommonName &cn) const

const std::string &	getObjectName () const

CDataContainer *	getObjectParent () const

const std::string &	getObjectType () const

virtual const CObjectInterface::ObjectSet &	getPrerequisites () const override

virtual const CValidity &	getValidity () const override

virtual void *	getValuePointer () const override

bool	hasFlag (const Flag &flag) const

virtual bool	isPrerequisiteForContext (const CObjectInterface *pObject, const CCore::SimulationContextFlag &context, const CObjectInterface::ObjectSet &changedObjects) const override

bool	prerequisitsContains (const DataObjectSet &objects) const

virtual void	print (std::ostream *ostream) const override

void	removeIssue (const CIssue &issue)

void	removeReference (const CDataContainer *pReference)

bool	setObjectName (const std::string &name)

virtual bool	setObjectParent (const CDataContainer *pParent)

void	validityChanged (const CValidity &changedValidity) override

void	validityRemoved (const CValidity &changedValidity)

virtual	~CDataObject ()

Public Member Functions inherited from CObjectInterface
	CObjectInterface ()

	CObjectInterface (const CObjectInterface &src)

virtual	~CObjectInterface ()

Public Member Functions inherited from CUndoObjectInterface
	CUndoObjectInterface ()

	CUndoObjectInterface (const CUndoObjectInterface &src)

bool	generateUuid ()

const xg::Guid &	getUuid () const

bool	setUuid (const std::string &uuid)

bool	setUuid (const xg::Guid &uuid)

virtual	~CUndoObjectInterface ()

Private Attributes
std::string	mKey

CDataVector< CLGlobalRenderInformation >	mvGlobalRenderInformationObjects

Additional Inherited Members
Public Types inherited from CDataVectorN< CLayout >
typedef CDataObjectMap::const_type_iterator< CLayout >	const_name_iterator

typedef CDataObjectMap::type_iterator< CLayout >	name_iterator

Public Types inherited from CDataVector< CType >
typedef CDataObjectMap::const_type_iterator< CType >	const_name_iterator

typedef CDataObjectMap::type_iterator< CType >	name_iterator

Public Types inherited from CDataContainer
typedef CDataObjectMap	objectMap

Public Types inherited from CDataObject
typedef std::set< const CDataObject * >	DataObjectSet

enum	Flag { Container , Vector , Matrix , NameVector , Reference , ValueBool , ValueInt , ValueInt64 , ValueDbl , NonUniqueName , StaticString , ValueString , Separator , DisplayName , ModelEntity , Array , DataModel , Root , Gui , __SIZE }

Public Types inherited from CObjectInterface
typedef std::vector< const CDataContainer * >	ContainerList

typedef std::set< const CObjectInterface * >	ObjectSet

Static Public Member Functions inherited from CDataContainer
static CDataContainer *	fromData (const CData &data, CUndoObjectInterface *pParent)

Static Public Member Functions inherited from CDataObject
static CDataObject *	fromData (const CData &data, CUndoObjectInterface *pParent)

static void	sanitizeObjectName (std::string &name)

Static Public Member Functions inherited from CObjectInterface
static const CDataObject *	DataObject (const CObjectInterface *pInterface)

static CObjectInterface *	GetObjectFromCN (const ContainerList &listOfContainer, const CCommonName &objName)

Static Public Member Functions inherited from CUndoObjectInterface
template<class CType >
static CType *	fromData (const CData &, CUndoObjectInterface *)

Static Public Attributes inherited from CDataContainer
static const CObjectInterface::ContainerList	EmptyList

Protected Member Functions inherited from CDataVector< CType >
	CDataVector (const CDataVector< CType > &src)

Protected Member Functions inherited from CDataContainer
template<class CType >
CDataMatrixReference< CType > *	addMatrixReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)

template<class CType >
CDataObjectReference< CType > *	addObjectReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)

template<class CType >
CDataVectorReference< CType > *	addVectorReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)

	CDataContainer (const CDataContainer &src)

void	initObjects ()

Protected Member Functions inherited from CDataObject
	CDataObject ()

	CDataObject (const std::string &name, const CDataContainer pParent=static_cast< CDataContainer >((void *) 0), const std::string &type="CN", const CFlags< Flag > &flag=CFlags< Flag >::None)

Protected Attributes inherited from CDataContainer
objectMap	mObjects

Protected Attributes inherited from CDataObject
ObjectSet	mPrerequisits

std::set< CDataContainer * >	mReferences

Protected Attributes inherited from CObjectInterface
CValidity	mValidity

Detailed Description

this class stores a list of layouts. It should also keep the maps that translate from sbml IDs to COPASI keys

Constructor & Destructor Documentation

◆ CListOfLayouts()

CListOfLayouts::CListOfLayouts	(	const std::string &	name = `"ListOfLayouts"`,
		const CDataContainer *	pParent = `NULL`
	)

◆ ~CListOfLayouts()

CListOfLayouts::~CListOfLayouts ( )

References CRootContainer::getKeyFactory(), mKey, and CKeyFactory::remove().

Member Function Documentation

◆ addGlobalRenderInformation()

void CListOfLayouts::addGlobalRenderInformation ( CLGlobalRenderInformation * pRenderInfo )

add local render information to layout. The layout takes ownership of the object.

References CDataVector< CType >::add(), and mvGlobalRenderInformationObjects.

Referenced by CXMLParserData::createRenderInformation(), and SBMLDocumentLoader::readListOfLayouts().

◆ addLayout()

void CListOfLayouts::addLayout	(	CLayout *	layout,
		const std::map< std::string, std::string > &	m
	)

Add a layout to the list. At the moment the map is just ignored. Later it should be stored somewhere

References CDataVectorN< CLayout >::add().

Referenced by SBMLDocumentLoader::readListOfLayouts().

◆ exportToSBML()

void CListOfLayouts::exportToSBML	(	ListOf *	lol,
		std::map< const CDataObject , SBase > &	copasimodelmap,
		const std::map< std::string, const SBase * > &	idMap,
		unsigned int	level,
		unsigned int	version
	)		const

This method writes the information of the copasi layout object into the corresponding sbml object. copasimodelmap maps the copasi model objects to libsbml objects. At the moment we don´t assume layout objects are in the copasimodelmap. idSet should contain all sbml IDs that are used in the currently exported model (including the layouts, but not the objects inside the layout).

References CLayout::exportToSBML(), getKey(), LAYOUT_CREATE_NS, mvGlobalRenderInformationObjects, CDataVectorN< CLayout >::operator[](), pdelete, and CDataVector< CType >::size().

Referenced by CSBMLExporter::exportLayout().