CCopasiRootContainer Class Reference

#include <CCopasiRootContainer.h>

Inheritance diagram for CCopasiRootContainer:

List of all members.

Public Member Functions
virtual	~CCopasiRootContainer ()
Static Public Member Functions
static void	init (int argc, char **argv, const bool &withGui=false)
static void	destroy ()
static const CCopasiContainer *	getRoot ()
static CConfigurationFile *	getConfiguration ()
static CFunctionDB *	getFunctionList ()
static CCopasiVector < CCopasiDataModel > *	getDatamodelList ()
static CCopasiDataModel *	addDatamodel ()
static CFunction *	getUndefinedFunction ()
static CKeyFactory *	getKeyFactory ()
static bool	removeDatamodel (const CCopasiDataModel *pDatamodel)
static bool	removeDatamodel (const unsigned C_INT32 index)
static const char *	getLicenseTxt ()
static const char *	getLicenseHTML ()
Protected Attributes
CKeyFactory	mKeyFactory
CFunctionDB *	mpFunctionList
CConfigurationFile *	mpConfiguration
CCopasiVector< CCopasiDataModel > *	mpDataModelList
bool	mWithGUI
CFunction *	mpUndefined

---

Detailed Description

This is the new root container class. It will hold some attributes that are used by all datamodels, e.g.the global function database and the configuration, and it will hold a list of datamodels. Currently all methods to create new instances of CCopasiRootContainer are declared private. This ensures that there can be only one root container which is initialized by the init method. If this is necessary or not needs to be discussed.

---

Constructor & Destructor Documentation

CCopasiRootContainer::~CCopasiRootContainer

(

)

[virtual]

---

Member Function Documentation

CCopasiDataModel * CCopasiRootContainer::addDatamodel

(

)

[static]

Creates a new datamodel instance and adds it to the list. The new instance is returned by the method.

void CCopasiRootContainer::destroy

(

)

[static]

CConfigurationFile * CCopasiRootContainer::getConfiguration

(

)

[static]

Returns the a pointer to the configuration.

CCopasiVector< CCopasiDataModel > * CCopasiRootContainer::getDatamodelList

(

)

[static]

Returns a pointer to the list of data models.

CFunctionDB * CCopasiRootContainer::getFunctionList

(

)

[static]

Returns a pointer to the global function database.

CKeyFactory * CCopasiRootContainer::getKeyFactory

(

)

[static]

Returns a pointer to the KeyFactory.

const char * CCopasiRootContainer::getLicenseHTML

(

)

[static]

const char * CCopasiRootContainer::getLicenseTxt

(

)

[static]

const CCopasiContainer * CCopasiRootContainer::getRoot

(

)

[static]

Retrieve the root container

CFunction * CCopasiRootContainer::getUndefinedFunction

(

)

[static]

Retrieve the pointer for the function used for importing kinetics without a kinetic law

Returns:

CFunction * pUnsupportedDelay

void CCopasiRootContainer::init	(	int	argc,
		char **	argv,
		const bool &	withGUI = false
	)		[static]

This method creates the only root container.

bool CCopasiRootContainer::removeDatamodel

(

const CCopasiDataModel *

pDatamodel

)

[static]

bool CCopasiRootContainer::removeDatamodel

(

const unsigned C_INT32

index

)

[static]

---

Member Data Documentation

CKeyFactory CCopasiRootContainer::mKeyFactory [protected]

CConfigurationFile* CCopasiRootContainer::mpConfiguration [protected]

CCopasiVector<CCopasiDataModel>* CCopasiRootContainer::mpDataModelList [protected]

CFunctionDB* CCopasiRootContainer::mpFunctionList [protected]

CFunction* CCopasiRootContainer::mpUndefined [protected]

bool CCopasiRootContainer::mWithGUI [protected]

---

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

• copasi/report/CCopasiRootContainer.h
• copasi/report/CCopasiRootContainer.cpp