#include <CProcessReport.h>

Public Member Functions
size_t	addItem (const std::string &name, const C_FLOAT64 &value, const C_FLOAT64 *pEndValue=NULL)

size_t	addItem (const std::string &name, const C_INT32 &value, const C_INT32 *pEndValue=NULL)

size_t	addItem (const std::string &name, const std::string &value, const std::string *pEndValue=NULL)

size_t	addItem (const std::string &name, const unsigned C_INT32 &value, const unsigned C_INT32 *pEndValue=NULL)

	CProcessReportLevel (CProcessReport *pInterface=NULL)

bool	finish ()

bool	finishItem (const size_t &handle)

	operator bool () const

CProcessReportLevel	operator++ ()

bool	proceed ()

bool	progress ()

bool	progressItem (const size_t &handle)

bool	resetItem (const size_t &handle)

void	setIgnoreStop (const bool &ignoreStop=true)

bool	setName (const std::string &name)

CProcessReport *	toProcessReportPtr ()

	~CProcessReportLevel ()

Private Attributes
size_t	mLevel

size_t	mMaxDisplayLevel

CProcessReport *	mpInterface

Constructor & Destructor Documentation

◆ CProcessReportLevel()

CProcessReportLevel::CProcessReportLevel ( CProcessReport * pInterface = NULL )

Specific Constructor

Parameters

CProcessReport * pInterface

◆ ~CProcessReportLevel()

CProcessReportLevel::~CProcessReportLevel ( )

Destructor

Member Function Documentation

◆ addItem() [1/4]

size_t CProcessReportLevel::addItem	(	const std::string &	name,
		const C_FLOAT64 &	value,
		const C_FLOAT64 *	pEndValue = `NULL`
	)

Add a process report item to to the list of reporting items. The return value is the handle of the item and can be used to indicate process, finish, or reset the item. If the method fails C_INVALID_INDEX is returned.

Parameters

const	std::string & name
const	C_FLOAT64 & value
const	C_FLOAT64 * pEndValue = NULL

Returns: size_t handle

References CProcessReport::addItem(), C_INVALID_INDEX, CCopasiParameter::DOUBLE, mLevel, mMaxDisplayLevel, and mpInterface.

◆ addItem() [2/4]

size_t CProcessReportLevel::addItem	(	const std::string &	name,
		const C_INT32 &	value,
		const C_INT32 *	pEndValue = `NULL`
	)

Add a process report item to to the list of reporting items. The return value is the handle of the item and can be used to indicate process, finish, or reset the item. If the method fails C_INVALID_INDEX is returned.

Parameters

const	std::string & name
const	C_INT32 & value
const	C_INT32 * pEndValue = NULL

Returns: size_t handle

References CProcessReport::addItem(), C_INVALID_INDEX, CCopasiParameter::INT, mLevel, mMaxDisplayLevel, and mpInterface.

◆ addItem() [3/4]

size_t CProcessReportLevel::addItem	(	const std::string &	name,
		const std::string &	value,
		const std::string *	pEndValue = `NULL`
	)

Add a process report item to to the list of reporting items. The return value is the handle of the item and can be used to indicate process, finish, or reset the item. If the method fails C_INVALID_INDEX is returned.

Parameters

const	std::string & name
const	std::string & value
const	std::string * pEndValue = NULL

Returns: size_t handle

References CProcessReport::addItem(), C_INVALID_INDEX, mLevel, mMaxDisplayLevel, mpInterface, and CCopasiParameter::STRING.

Referenced by CBitPatternMethod::calculate(), CBitPatternTreeMethod::calculate(), CEFMAlgorithm::calculateNextTableau(), CNewtonMethod::doIntegration(), CBitPatternMethod::initialize(), CBitPatternTreeMethod::initialize(), CEFMAlgorithm::initialize(), CSSAMethod::initialize(), COptMethodCoranaWalk::initialize(), COptMethodHookeJeeves::initialize(), COptMethodLevenbergMarquardt::initialize(), COptMethodNelderMead::initialize(), COptMethodPS::initialize(), COptMethodSA::initialize(), COptMethodSS::initialize(), COptPopulationMethod::initialize(), CSensMethod::process(), CLyapTask::process(), CScanTask::process(), CTimeSensTask::process(), CTSSATask::process(), CAnalyticsTask::process(), CCrossSectionTask::process(), CNewtonMethod::processNewton(), CTrajectoryTask::processTrajectory(), CTrajectoryTask::processValues(), and COptProblem::setCallBack().

◆ addItem() [4/4]

size_t CProcessReportLevel::addItem	(	const std::string &	name,
		const unsigned C_INT32 &	value,
		const unsigned C_INT32 *	pEndValue = `NULL`
	)

Add a process report item to to the list of reporting items. The return value is the handle of the item and can be used to indicate process, finish, or reset the item. If the method fails C_INVALID_INDEX is returned.

Parameters

const	std::string & name
const	unsigned C_INT32 & value
const	unsigned C_INT32 * pEndValue = NULL

Returns: size_t handle

References CProcessReport::addItem(), C_INVALID_INDEX, mLevel, mMaxDisplayLevel, mpInterface, and CCopasiParameter::UINT.

◆ finish()

bool CProcessReportLevel::finish ( )

Indicate that all items are finished reporting. All item handles loose their validity. If the return value is false the calling process must halt execution and return.

Parameters

bool continue

References CProcessReport::finish(), mpInterface, and proceed().

◆ finishItem()

bool CProcessReportLevel::finishItem ( const size_t & handle )

Indicate that item handle is finished reporting. The handle of that item is no longer valid after the call. If the return value is false the calling process must halt execution and return.

Parameters

const	size_t & handle
bool	continue

References CProcessReport::finishItem(), mLevel, mMaxDisplayLevel, mpInterface, and proceed().

◆ operator bool()

CProcessReportLevel::operator bool ( ) const

Check whether we actually have an active interface

Returns: bool haveInterface

◆ operator++()

CProcessReportLevel CProcessReportLevel::operator++ ( )

Increase the level of the progress report

Returns: CProcessReport *

References mLevel.

◆ proceed()

bool CProcessReportLevel::proceed ( )

Check whether processing shall proceed. If the return value is false the calling process must halt execution and return. This method is provided so that lengthy processing without advances in any of the reporting items can check whether continuation is requested.

Parameters

bool continue

References mpInterface, and CProcessReport::proceed().

Referenced by CLyapWolfMethod::calculate(), CEFMAlgorithm::calculateNextTableau(), CBitPatternTreeMethod::combine(), CBitPatternMethod::combine(), finish(), finishItem(), CTimeSensTask::processStep(), CTrajectoryTask::processStep(), progress(), progressItem(), and resetItem().

◆ progress()

bool CProcessReportLevel::progress ( )

Report process on all items. If the return value is false the calling process must halt execution and return.

Parameters

bool continue

References mpInterface, proceed(), and CProcessReport::progress().

◆ progressItem()

bool CProcessReportLevel::progressItem ( const size_t & handle )

Report process on item handle. If the return value is false the calling process must halt execution and return.

Parameters

const	size_t & handle
bool	continue

References mLevel, mMaxDisplayLevel, mpInterface, proceed(), and CProcessReport::progressItem().

◆ resetItem()

bool CProcessReportLevel::resetItem ( const size_t & handle )

Reset item handle. This means that the value of the item has changed but not as part of a continuous process. If you run multiple processes call reset between them. If the return value is false the calling process must halt execution and return.

Parameters