CScanMethod Class Reference

#include <CScanMethod.h>

Inheritance diagram for CScanMethod:

List of all members.

Public Member Functions
	~CScanMethod ()
void	setProblem (CScanProblem *problem)
bool	init ()
bool	scan ()
unsigned C_INT32	getTotalNumberOfSteps () const
virtual bool	isValidProblem (const CCopasiProblem *pProblem)
Static Public Member Functions
static CScanMethod *	createMethod ()
Protected Member Functions
	CScanMethod (CCopasiMethod::SubType subType, const CCopasiContainer *pParent=NULL)
Protected Attributes
CScanProblem *	mpProblem
CScanTask *	mpTask
CRandom *	mpRandomGenerator
std::vector< CScanItem * >	mScanItems
std::vector< Refresh * >	mInitialRefreshes
unsigned C_INT32	mTotalSteps
C_INT32	mLastNestingItem

---

Constructor & Destructor Documentation

CScanMethod::CScanMethod	(	CCopasiMethod::SubType	subType,
		const CCopasiContainer *	pParent = NULL
	)		[protected]

Specific constructor.

Parameters:

CCopasiMethod::SubType	subType
const	CCopasiContainer * pParent (default: NULL)

CScanMethod::~CScanMethod

(

)

Copy constructor.

Parameters:

const CTrajectoryMethod &

src Destructor.

---

Member Function Documentation

CScanMethod * CScanMethod::createMethod

(

)

[static]

Create a trajectory method. Note: the returned object has to be released after use with delete

unsigned C_INT32 CScanMethod::getTotalNumberOfSteps

(

)

const [inline]

bool CScanMethod::init

(

)

bool CScanMethod::isValidProblem

(

const CCopasiProblem *

pProblem

)

[virtual]

The main scan method. Check if the method is suitable for this problem

Returns:

bool suitability of the method

Reimplemented from CCopasiMethod.

bool CScanMethod::scan

(

)

void CScanMethod::setProblem

(

CScanProblem *

problem

)

Set a pointer to the problem. This method is used by CTrajectory

Parameters:

CTrajectoryProblem *

problem

---

Member Data Documentation

std::vector< Refresh * > CScanMethod::mInitialRefreshes [protected]

C_INT32 CScanMethod::mLastNestingItem [protected]

the index of the last item that has several subitems, also the last item that need to generate output separators

CScanProblem* CScanMethod::mpProblem [protected]

A pointer to the trajectory problem.

CRandom* CScanMethod::mpRandomGenerator [protected]

A pointer to the random number generator

CScanTask* CScanMethod::mpTask [protected]

A pointer to the scan Task.

std::vector<CScanItem*> CScanMethod::mScanItems [protected]

unsigned C_INT32 CScanMethod::mTotalSteps [protected]

---

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

• copasi/scan/CScanMethod.h
• copasi/scan/CScanMethod.cpp