CScanProblem Class Reference

#include <CScanProblem.h>

Inheritance diagram for CScanProblem:

List of all members.

Public Types
enum	Type {   SCAN_REPEAT = 0, SCAN_LINEAR, SCAN_RANDOM, SCAN_BREAK,   SD_UNIFORM, SD_GAUSS, SD_BOLTZ, SD_REGULAR }
Public Member Functions
	CScanProblem (const CCopasiContainer *pParent=NULL)
	CScanProblem (const CScanProblem &src, const CCopasiContainer *pParent=NULL)
	~CScanProblem ()
void	setSubtask (CCopasiTask::Type type)
CCopasiTask::Type	getSubtask () const
void	setOutputInSubtask (bool ois)
const bool &	getOutputInSubtask () const
void	setAdjustInitialConditions (bool aic)
const bool &	getAdjustInitialConditions () const
unsigned C_INT32	getNumberOfScanItems () const
const CCopasiParameterGroup *	getScanItem (unsigned C_INT32 index) const
CCopasiParameterGroup *	getScanItem (unsigned C_INT32 index)
CScanProblem::Type	getScanItemType (unsigned C_INT32 index)
CCopasiParameterGroup *	createScanItem (CScanProblem::Type type, unsigned C_INT32 steps=5, const CCopasiObject *obj=NULL)
void	clearScanItems ()
void	load (CReadConfig &configBuffer, CReadConfig::Mode mode=CReadConfig::NEXT)

---

Detailed Description

CScanProblem class.

---

Member Enumeration Documentation

enum CScanProblem::Type

Enumerator:

SCAN_REPEAT
SCAN_LINEAR
SCAN_RANDOM
SCAN_BREAK
SD_UNIFORM
SD_GAUSS
SD_BOLTZ
SD_REGULAR

Reimplemented from CCopasiParameter.

---

Constructor & Destructor Documentation

CScanProblem::CScanProblem

(

const CCopasiContainer *

pParent = NULL

)

Default constructor.

Parameters:

const

CCopasiContainer * pParent (default: NULL)

CScanProblem class. Default constructor.

Parameters:

CModel *

pModel

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

Copy constructor.

Parameters:

const

CTrajectoryProblem & src CCopasiContainer * pParent (default: NULL)

Copy constructor.

Parameters:

const CScanProblem &

src

CScanProblem::~CScanProblem

(

)

Destructor.

---

Member Function Documentation

void CScanProblem::clearScanItems

(

)

CCopasiParameterGroup * CScanProblem::createScanItem	(	CScanProblem::Type	type,
		unsigned C_INT32	steps = 5,
		const CCopasiObject *	obj = NULL
	)

const bool & CScanProblem::getAdjustInitialConditions

(

)

const

Ask if initial conditions should be set to the result of the previous run.

unsigned C_INT32 CScanProblem::getNumberOfScanItems

(

)

const

const bool & CScanProblem::getOutputInSubtask

(

)

const

Ask if output should be done after every step of the subtask.

const CCopasiParameterGroup * CScanProblem::getScanItem

(

unsigned C_INT32

index

)

const

CCopasiParameterGroup * CScanProblem::getScanItem

(

unsigned C_INT32

index

)

CScanProblem::Type CScanProblem::getScanItemType

(

unsigned C_INT32

index

)

CCopasiTask::Type CScanProblem::getSubtask

(

)

const

Get the type of the subtask.

void CScanProblem::load	(	CReadConfig &	configBuffer,
		CReadConfig::Mode	mode = CReadConfig::NEXT
	)

Load a scan problem

Parameters:

CReadConfig &	configBuffer
"CReadConfig::Mode	mode (Default: CReadConfig::NEXT)

void CScanProblem::setAdjustInitialConditions

(

bool

aic

)

Set if initial conditions should be set to the result of the previous run.

void CScanProblem::setOutputInSubtask

(

bool

ois

)

Set if output should be done after every step of the subtask.

void CScanProblem::setSubtask

(

CCopasiTask::Type

type

)

Set the type of the subtask.

---

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

• copasi/scan/CScanProblem.h
• copasi/scan/CScanProblem.cpp