CSensProblem Class Reference

#include <CSensProblem.h>

Inheritance diagram for CSensProblem:

List of all members.

Public Types
enum	SubTaskType { Evaluation, SteadyState, TimeSeries }
Public Member Functions
	CSensProblem (const CCopasiContainer *pParent=NULL)
	CSensProblem (const CSensProblem &src, const CCopasiContainer *pParent=NULL)
virtual	~CSensProblem ()
void	setSubTaskType (const CSensProblem::SubTaskType &type)
CSensProblem::SubTaskType	getSubTaskType () const
CSensItem	getTargetFunctions () const
void	changeTargetFunctions (const CSensItem item)
unsigned C_INT32	getNumberOfVariables () const
CSensItem	getVariables (unsigned C_INT32 index) const
void	addVariables (const CSensItem &item)
bool	changeVariables (unsigned C_INT32 index, const CSensItem &item)
bool	removeVariables (unsigned C_INT32 index)
bool	removeVariables ()
CCopasiArray &	getResult ()
const CCopasiArray &	getResult () const
CArrayAnnotation *	getResultAnnotated ()
const CArrayAnnotation *	getResultAnnotated () const
CCopasiArray &	getScaledResult ()
const CCopasiArray &	getScaledResult () const
CArrayAnnotation *	getScaledResultAnnotated ()
const CArrayAnnotation *	getScaledResultAnnotated () const
CCopasiArray &	getCollapsedResult ()
const CCopasiArray &	getCollapsedResult () const
CArrayAnnotation *	getCollapsedResultAnnotated ()
const CArrayAnnotation *	getCollapsedResultAnnotated () const
bool	collapsRequested () const
virtual void	printResult (std::ostream *ostream) const
virtual void	print (std::ostream *ostream) const
Static Public Member Functions
static std::vector < CObjectLists::ListType >	getPossibleTargetFunctions (CSensProblem::SubTaskType)
static std::vector < CObjectLists::ListType >	getPossibleVariables (CSensProblem::SubTaskType)
Static Public Attributes
static const std::string	SubTaskName []
static const char *	XMLSubTask []
Friends
std::ostream &	operator<< (std::ostream &os, const CSensProblem &o)

---

Detailed Description

CSensProblem class.

---

Member Enumeration Documentation

enum CSensProblem::SubTaskType

this enumeration

Enumerator:

Evaluation
SteadyState
TimeSeries

---

Constructor & Destructor Documentation

CSensProblem::CSensProblem

(

const CCopasiContainer *

pParent = NULL

)

Default constructor.

Parameters:

const

CCopasiContainer * pParent (default: NULL)

Default constructor.

Parameters:

CModel *

pModel

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

Copy constructor.

Parameters:

const CSensProblem &

src CCopasiContainer * pParent (default: NULL)

Copy constructor.

Parameters:

const CSensProblem &

src

CSensProblem::~CSensProblem

(

)

[virtual]

Destructor.

---

Member Function Documentation

void CSensProblem::addVariables

(

const CSensItem &

item

)

void CSensProblem::changeTargetFunctions

(

const CSensItem

item

)

bool CSensProblem::changeVariables	(	unsigned C_INT32	index,
		const CSensItem &	item
	)

bool CSensProblem::collapsRequested

(

)

const

CCopasiArray & CSensProblem::getCollapsedResult

(

)

const CCopasiArray & CSensProblem::getCollapsedResult

(

)

const

CArrayAnnotation * CSensProblem::getCollapsedResultAnnotated

(

)

const CArrayAnnotation * CSensProblem::getCollapsedResultAnnotated

(

)

const

unsigned C_INT32 CSensProblem::getNumberOfVariables

(

)

const

std::vector< CObjectLists::ListType > CSensProblem::getPossibleTargetFunctions

(

CSensProblem::SubTaskType

type

)

[static]

std::vector< CObjectLists::ListType > CSensProblem::getPossibleVariables

(

CSensProblem::SubTaskType

type

)

[static]

CCopasiArray & CSensProblem::getResult

(

)

const CCopasiArray & CSensProblem::getResult

(

)

const

CArrayAnnotation * CSensProblem::getResultAnnotated

(

)

const CArrayAnnotation * CSensProblem::getResultAnnotated

(

)

const

CCopasiArray & CSensProblem::getScaledResult

(

)

const CCopasiArray & CSensProblem::getScaledResult

(

)

const

CArrayAnnotation * CSensProblem::getScaledResultAnnotated

(

)

const CArrayAnnotation * CSensProblem::getScaledResultAnnotated

(

)

const

CSensProblem::SubTaskType CSensProblem::getSubTaskType

(

)

const

get the problem's SubTaskType:

CSensItem CSensProblem::getTargetFunctions

(

)

const

CSensItem CSensProblem::getVariables

(

unsigned C_INT32

index

)

const

void CSensProblem::print

(

std::ostream *

ostream

)

const [virtual]

This is the output method for any object. It calls the insert operator<<

Parameters:

std::ostream

* ostream

Reimplemented from CCopasiProblem.

void CSensProblem::printResult

(

std::ostream *

ostream

)

const [virtual]

This is the output method for any result of a problem. The default implementation provided with CCopasiProblem. Does only print "Not implemented." To overide this default behaviour one needs to reimplement the virtual printResult function.

Parameters:

std::ostream

* ostream

Reimplemented from CCopasiProblem.

bool CSensProblem::removeVariables

(

unsigned C_INT32

index

)

bool CSensProblem::removeVariables

(

)

void CSensProblem::setSubTaskType

(

const CSensProblem::SubTaskType &

type

)

set the problem's SubTaskType:

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const CSensProblem &	o
	)		[friend]

Output stream operator. Prints description of the problem

Parameters:

ostream	& os
const	Problem & A

Returns:

ostream & os

---

Member Data Documentation

const std::string CSensProblem::SubTaskName [static]

Initial value:

{
  "Evaluation",
  "Steady State",
  "Time Series",
  
  ""
}

const char * CSensProblem::XMLSubTask [static]

Initial value:

{
  "Evaluation",
  "SteadyState",
  "TimeSeries",
  
  NULL
}

---

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

• copasi/sensitivities/CSensProblem.h
• copasi/sensitivities/CSensProblem.cpp