#include <CModelParameter.h>

Inheritance diagram for CModelParameterCompartment:

Public Member Functions
void	addSpecies (CModelParameterSpecies *pSpecies)

	CModelParameterCompartment (CModelParameterGroup *pParent, const CModelParameter::Type &type=CModelParameter::Type::Compartment)

	CModelParameterCompartment (const CModelParameterCompartment &src, CModelParameterGroup *pParent)

void	removeSpecies (CModelParameterSpecies *pSpecies)

virtual void	setValue (const C_FLOAT64 &value, const CCore::Framework &framework, bool updateModelIfActive=true)

virtual	~CModelParameterCompartment ()

Public Member Functions inherited from CModelParameter
virtual bool	applyData (const CData &data, CUndoData::CChangeSet &changes)

	CModelParameter (CModelParameterGroup *pParent, const CModelParameter::Type &type)

	CModelParameter (const CModelParameter &src, CModelParameterGroup *pParent)

virtual void	compile ()

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

virtual void	destruct ()

virtual const CompareResult &	diff (const CModelParameter &other, const CCore::Framework &framework=CCore::Framework::ParticleNumbers, const bool &createMissing=false)

virtual const CModelParameter *	getChild (const size_t &index) const

const CCommonName &	getCN () const

const CompareResult &	getCompareResult () const

virtual size_t	getIndex () const

std::string	getInitialExpression () const

const CExpression *	getInitialExpressionPtr () const

CModel *	getModel () const

virtual std::string	getName () const

virtual size_t	getNumChildren () const

CDataObject *	getObject () const

CModelParameterGroup *	getParent () const

CModelParameterSet *	getSet () const

const CModelEntity::Status &	getSimulationType () const

const Type &	getType () const

CValidatedUnit	getUnit (const CCore::Framework &framework) const

virtual const double &	getValue (const CCore::Framework &framework) const

bool	isInitialExpressionValid () const

bool	isReadOnly () const

bool	operator< (const CModelParameter &rhs) const

virtual bool	refreshFromModel (const bool &modifyExistence)

virtual void	setCN (const CCommonName &cn)

void	setCompareResult (const CompareResult &compareResult)

void	setInitialExpression (const std::string &initialExpression)

void	setParent (CModelParameterGroup *pParent)

bool	setSimulationType (const CModelEntity::Status &simulationType)

virtual CData	toData () const

virtual CModelParameterSet *	toSet ()

virtual const CModelParameterSet *	toSet () const

virtual bool	updateModel ()

virtual	~CModelParameter ()

Public Member Functions inherited from CUndoObjectInterface
	CUndoObjectInterface ()

	CUndoObjectInterface (const CUndoObjectInterface &src)

bool	generateUuid ()

const xg::Guid &	getUuid () const

virtual CUndoObjectInterface *	insert (const CData &data)

bool	setUuid (const std::string &uuid)

bool	setUuid (const xg::Guid &uuid)

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

virtual	~CUndoObjectInterface ()

Private Attributes
std::set< CModelParameterSpecies * >	mSpecies

Additional Inherited Members
Public Types inherited from CModelParameter
enum class	CompareResult { Obsolete , Missing , Modified , Conflict , Identical , __SIZE }

enum class	Type { Model , Compartment , Species , ModelValue , ReactionParameter , Reaction , Group , Set , unknown , __SIZE }

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

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

Static Public Attributes inherited from CModelParameter
static const CEnumAnnotation< std::string, CompareResult >	CompareResultNames

static const CEnumAnnotation< std::string, Type >	TypeNames

Protected Attributes inherited from CModelParameter
CRegisteredCommonName	mCN

CompareResult	mCompareResult

bool	mIsInitialExpressionValid

CExpression *	mpInitialExpression

CDataObject *	mpObject

CModelParameterGroup *	mpParent

CModelEntity::Status	mSimulationType

Type	mType

double	mValue

Constructor & Destructor Documentation

◆ CModelParameterCompartment() [1/2]

CModelParameterCompartment::CModelParameterCompartment	(	CModelParameterGroup *	pParent,
		const CModelParameter::Type &	type = `CModelParameter::Type::Compartment`
	)

Constructor

◆ CModelParameterCompartment() [2/2]

CModelParameterCompartment::CModelParameterCompartment	(	const CModelParameterCompartment &	src,
		CModelParameterGroup *	pParent
	)

Copy constructor

◆ ~CModelParameterCompartment()

CModelParameterCompartment::~CModelParameterCompartment ( )

virtual

Destructor

References mSpecies.

Member Function Documentation

◆ addSpecies()

void CModelParameterCompartment::addSpecies ( CModelParameterSpecies * pSpecies )

Add a pointer to a species parameter to the compartment

References mSpecies.

Referenced by CModelParameterSpecies::compile(), and CModelParameterSpecies::setValue().

◆ removeSpecies()

void CModelParameterCompartment::removeSpecies ( CModelParameterSpecies * pSpecies )

Remove a pointer to a species parameter from the compartment

References mSpecies.

Referenced by CModelParameterSpecies::~CModelParameterSpecies().

◆ setValue()

void CModelParameterCompartment::setValue	(	const C_FLOAT64 &	value,
		const CCore::Framework &	framework,
		bool	updateModelIfActive = `true`
	)

virtual

Set the value of the parameter based on the current framework

Parameters

const	double & value
const	Framework & framework
updateModelIfActive	if this is the active parameter set, write the changes back to the model

Reimplemented from CModelParameter.

References CVectorCore< CType >::array(), C_FLOAT64, CModelParameter::getSet(), CModelParameterSet::isActive(), mSpecies, CModelParameter::mValue, and CModelParameter::updateModel().

Member Data Documentation

◆ mSpecies

std::set< CModelParameterSpecies * > CModelParameterCompartment::mSpecies

private

The set of species parameters which are contained in the compartment

Referenced by addSpecies(), removeSpecies(), setValue(), and ~CModelParameterCompartment().

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

Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ CModelParameterCompartment() [1/2]

◆ CModelParameterCompartment() [2/2]

◆ ~CModelParameterCompartment()

Member Function Documentation

◆ addSpecies()

◆ removeSpecies()

◆ setValue()

Member Data Documentation

◆ mSpecies