CEvent Class Reference

#include <CEvent.h>

Inheritance diagram for CEvent:

List of all members.

Public Member Functions
	CEvent (const std::string &name="NoName", const CCopasiContainer *pParent=NULL)
	CEvent (const CEvent &src, const CCopasiContainer *pParent=NULL)
	~CEvent ()
void	cleanup ()
virtual bool	setObjectParent (const CCopasiContainer *pParent)
virtual std::string	getObjectDisplayName (bool regular=true, bool richtext=false) const
virtual const std::string &	getKey () const
bool	compile (std::vector< CCopasiContainer * > listOfContainer)
void	setOrder (const unsigned C_INT32 &order, const bool &correctOther=true)
const unsigned C_INT32 &	getOrder () const
void	setSBMLId (const std::string &id)
const std::string &	getSBMLId () const
void	setDelayAssignment (const bool &delayCalculation)
const bool &	getDelayAssignment () const
bool	setTriggerExpression (const std::string &expression)
void	setTriggerExpressionPtr (CExpression *pExpression)
std::string	getTriggerExpression () const
const CExpression *	getTriggerExpressionPtr () const
CExpression *	getTriggerExpressionPtr ()
bool	setDelayExpression (const std::string &expression)
void	setDelayExpressionPtr (CExpression *pExpression)
std::string	getDelayExpression () const
CExpression *	getDelayExpressionPtr ()
const CExpression *	getDelayExpressionPtr () const
const CCopasiVectorN < CEventAssignment > &	getAssignments () const
CCopasiVectorN < CEventAssignment > &	getAssignments ()
void	deleteAssignment (const std::string &key)
Friends
std::ostream &	operator<< (std::ostream &os, const CEvent &d)

---

Constructor & Destructor Documentation

CEvent::CEvent	(	const std::string &	name = "NoName",
		const CCopasiContainer *	pParent = NULL
	)

Default constructor

Parameters:

const	std::string & name (default: "NoName")
const	CCopasiContainer * pParent (default: NULL)

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

Copy constructor

Parameters:

const CEvent &	src
const	CCopasiContainer * pParent (default: NULL)

CEvent::~CEvent

(

)

Destructor

---

Member Function Documentation

void CEvent::cleanup

(

)

Delete

bool CEvent::compile

(

std::vector< CCopasiContainer * >

listOfContainer

)

Compile the event.

Parameters:

std::vector<

CCopasiContainer * > listOfContainer

Returns:

bool success

void CEvent::deleteAssignment

(

const std::string &

key

)

Delete assignment with the given key. Please note this is not the target key.

Parameters:

const

std::string & key

const CCopasiVectorN< CEventAssignment > & CEvent::getAssignments

(

)

const

Retrieve the assignments

Returns:

const CCopasiVectorN< CEventAssignment > & assignments

CCopasiVectorN< CEventAssignment > & CEvent::getAssignments

(

)

Retrieve the assignments

Returns:

CCopasiVectorN< CEventAssignment > & assignments

const bool & CEvent::getDelayAssignment

(

)

const

Retrieve whether to delay the calculation of the assignment.

Returns:

const bool & delayCalculation

std::string CEvent::getDelayExpression

(

)

const

Retrieve the expression of the delay as a string.

Returns:

std::string expression

CExpression * CEvent::getDelayExpressionPtr

(

)

Retrieve the pointer to the expression of the delay.

Returns:

CExpression* pExpression

const CExpression * CEvent::getDelayExpressionPtr

(

)

const

Retrieve the pointer to the expression of the delay.

Returns:

CExpression* pExpression

const std::string & CEvent::getKey

(

)

const [virtual]

Retrieves the key of the event

Returns:

std::string key

Reimplemented from CCopasiObject.

std::string CEvent::getObjectDisplayName	(	bool	regular = true,
		bool	richtext = false
	)		const [virtual]

Retrieve display name. Special treatment for reaction to provide a shorter display

Reimplemented from CCopasiObject.

const unsigned C_INT32 & CEvent::getOrder

(

)

const

Retrieve the order in which the events is executed for simultaneous events

const std::string & CEvent::getSBMLId

(

)

const

Returns a reference to the SBML Id.

std::string CEvent::getTriggerExpression

(

)

const

Retrieve the expression of trigger as a string.

Returns:

std::string expression

const CExpression * CEvent::getTriggerExpressionPtr

(

)

const

Retrieve the pointer to the expression of trigger.

Returns:

CExpression* pExpression

CExpression * CEvent::getTriggerExpressionPtr

(

)

Retrieve the pointer to the expression of trigger.

Returns:

CExpression* pExpression

void CEvent::setDelayAssignment

(

const bool &

delayCalculation

)

Set whether the calculation or the assignment shall be delayed

Parameters:

bool CEvent::setDelayExpression

(

const std::string &

expression

)

Set the expression of delay from a string. The return value indicates if parsing the expression was successful.

Parameters:

const

std::string & expression

Returns:

bool success

void CEvent::setDelayExpressionPtr

(

CExpression *

pExpression

)

Set the expression of delay from an expression.

Parameters:

CExpression*

pExpression

bool CEvent::setObjectParent

(

const CCopasiContainer *

pParent

)

[virtual]

Set the object parent

Parameters:

const

CCopasiContainer * pParent

Returns:

bool success

Reimplemented from CCopasiObject.

void CEvent::setOrder	(	const unsigned C_INT32 &	order,
		const bool &	correctOther = true
	)

Set the order in which the event is executed for simultaneous events.

Parameters:

const

unsigned C_INT32 & order const bool & correctOther = true

void CEvent::setSBMLId

(

const std::string &

id

)

Sets the SBMLId.

Parameters:

const

std::string & id

bool CEvent::setTriggerExpression

(

const std::string &

expression

)

Set the expression of trigger from a string. The return value indicates if parsing the expression was successful.

Parameters:

const

std::string & expression

Returns:

bool success

void CEvent::setTriggerExpressionPtr

(

CExpression *

pExpression

)

Set the expression of trigger from an expression.

Parameters:

CExpression*

pExpression

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const CEvent &	d
	)		[friend]

insert operator

---

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

• copasi/model/CEvent.h
• copasi/model/CEvent.cpp