StoppingCriterion Class Reference

class which represent the stopping criterion to check to stop simulation a StoppingCriterion is either a Criterion or a MultipleCriterion a StoppingCriterion can be checked using checkCriterion method to know if the StoppingCriterion is reach More...

#include <StoppingCriterion.h>

Inherited by Criterion, and MultipleCriterion.

Public Member Functions
virtual bool	checkCriterion ()=0
	return true if the stopping criterion is reach More...
virtual StoppingCriterion *	getChild (const unsigned int i)=0
	get the child repered by index, return null if no child More...
virtual std::string	getName ()=0
	get stopping criterion name More...
virtual int	getNumberOfChildren ()=0
	get number of childre; return -1 for non multiple criteria More...
MultipleCriterion *	getParent ()
	get parent multiple criteria More...
	StoppingCriterion (MonitoringManager *monitoringManager, MultipleCriterion *parent=nullptr)
	constructor More...
virtual	~StoppingCriterion ()=default
	destructor More...

Protected Attributes
MonitoringManager *	monitoringManager
	monitoring manager More...
MultipleCriterion *	parent
	parent stopping Criterion More...

Detailed Description

class which represent the stopping criterion to check to stop simulation a StoppingCriterion is either a Criterion or a MultipleCriterion a StoppingCriterion can be checked using checkCriterion method to know if the StoppingCriterion is reach

Constructor & Destructor Documentation

StoppingCriterion()

StoppingCriterion::StoppingCriterion	(	MonitoringManager *	monitoringManager,
		MultipleCriterion *	parent = nullptr
	)

constructor

References monitoringManager, and parent.

~StoppingCriterion()

virtual StoppingCriterion::~StoppingCriterion ( )

virtualdefault

destructor

Member Function Documentation

checkCriterion()

virtual bool StoppingCriterion::checkCriterion ( )

pure virtual

return true if the stopping criterion is reach

Implemented in Criterion, MultipleCriterion, AndMultipleCriterion, and OrMultipleCriterion.

Referenced by InteractiveMonitoringManager::checkStop().

getChild()

virtual StoppingCriterion* StoppingCriterion::getChild ( const unsigned int  i )

pure virtual

get the child repered by index, return null if no child

Implemented in Criterion, and MultipleCriterion.

Referenced by MonitoringDialog::createItem().

getName()

virtual std::string StoppingCriterion::getName ( )

pure virtual

get stopping criterion name

Implemented in Criterion, MultipleCriterion, AndMultipleCriterion, OrMultipleCriterion, ForceCriterion, kineticEnergy, Position, Time, and Velocity.

Referenced by MonitoringDialog::createItem().

getNumberOfChildren()

virtual int StoppingCriterion::getNumberOfChildren ( )

pure virtual

get number of childre; return -1 for non multiple criteria

Implemented in Criterion, and MultipleCriterion.

Referenced by MonitoringDialog::createItem().

getParent()

MultipleCriterion * StoppingCriterion::getParent

(

)

get parent multiple criteria

References parent.

Member Data Documentation

monitoringManager

MonitoringManager* StoppingCriterion::monitoringManager

protected

monitoring manager

Referenced by Position::calculate(), Time::calculate(), and StoppingCriterion().

parent

MultipleCriterion* StoppingCriterion::parent

protected

parent stopping Criterion

Referenced by getParent(), and StoppingCriterion().

---

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

• StoppingCriterion.h
• StoppingCriterion.cpp