#include <CScanMethod.h>

Inheritance diagram for CScanItemLinear:

Collaboration diagram for CScanItemLinear:

Public Member Functions
	CScanItemLinear (CCopasiParameterGroup *si, const bool &continueFromCurrentState)

virtual bool	isValidScanItem (const bool &continueFromCurrentState)

virtual void	step ()

virtual	~CScanItemLinear ()

Public Member Functions inherited from CScanItem
size_t	getNumSteps () const

const CCopasiObject *	getObject () const

bool	isFinished () const

virtual bool	isNesting () const

void	reset ()

void	restoreValue () const

void	storeValue ()

virtual	~CScanItem ()

Private Attributes
C_FLOAT64	mFaktor

bool	mLog

C_FLOAT64	mMax

C_FLOAT64	mMin

Additional Inherited Members
Static Public Member Functions inherited from CScanItem
static CScanItem *	createScanItemFromParameterGroup (CCopasiParameterGroup si, CRandom rg, const bool &continueFromCurrentState)

Protected Member Functions inherited from CScanItem
	CScanItem (CCopasiParameterGroup *si, const bool &continueFromCurrentState)

Protected Attributes inherited from CScanItem
bool	mFlagFinished

size_t	mIndex

bool	mIsStateVariable

size_t	mNumSteps

CCopasiObject *	mpInitialObject

CCopasiObject *	mpObject

C_FLOAT64	mStoreValue

Detailed Description

Definition at line 112 of file CScanMethod.h.

Constructor & Destructor Documentation

CScanItemLinear::CScanItemLinear	(	CCopasiParameterGroup *	si,
		const bool &	continueFromCurrentState
	)

Definition at line 209 of file CScanMethod.cpp.

References CCopasiParameterGroup::getValue(), mFaktor, mLog, mMax, mMin, CScanItem::mNumSteps, CCopasiParameter::Value::pBOOL, and CCopasiParameter::Value::pDOUBLE.

                                                                        :
   CScanItem(si, continueFromCurrentState),
   mLog(false)
 {
   mLog = * si->getValue("log").pBOOL;
   mMin = * si->getValue("Minimum").pDOUBLE;
   mMax = * si->getValue("Maximum").pDOUBLE;
 
   if (mLog)
     {
       mMin = log(mMin);
       mMax = log(mMax);
     }
 
   mFaktor = (mMax - mMin) / mNumSteps;
 
   //TODO: log scanning of negative values?
 }

virtual CScanItemLinear::~CScanItemLinear ( )

inlinevirtual

Definition at line 121 of file CScanMethod.h.

121 {};

Member Function Documentation

bool CScanItemLinear::isValidScanItem ( const bool & continueFromCurrentState )

virtual

perform checks. This is used in the method::isValidProblem() method. It returns false for an invalid ScanItem and generates a CCopasiMessage

Parameters

const bool & continueFromCurrentState

Reimplemented from CScanItem.

Definition at line 248 of file CScanMethod.cpp.

References CCopasiMessage::ERROR, CScanItem::isValidScanItem(), max, mFaktor, and mLog.

 {
   if (!CScanItem::isValidScanItem(continueFromCurrentState)) return false;
 
   if (mLog)
     {
       if (isnan(mFaktor) || mFaktor < - std::numeric_limits< C_FLOAT64 >::max() || std::numeric_limits< C_FLOAT64 >::max() < mFaktor)
         {
           //not a valid range for log
           CCopasiMessage(CCopasiMessage::ERROR, "Only positive values for min and max are possible for a logarithmic scan.");
           return false;
         }
     }
 
   return true;
 }

void CScanItemLinear::step ( )

virtual

Implements CScanItem.

Definition at line 229 of file CScanMethod.cpp.

References C_FLOAT64, mFaktor, CScanItem::mFlagFinished, CScanItem::mIndex, mLog, mMin, CScanItem::mNumSteps, CScanItem::mpInitialObject, CScanItem::mpObject, and CCopasiObject::setObjectValue().

 {
   //do something ...
   C_FLOAT64 Value = mMin + mIndex * mFaktor;
 
   if (mLog)
     Value = exp(Value);
 
   //the index
   if (mIndex > mNumSteps)
     mFlagFinished = true;
 
   if (mpObject) mpObject->setObjectValue(Value);
 
   if (mpInitialObject) mpInitialObject->setObjectValue(Value);
 
   ++mIndex;
 }