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>

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

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

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.

Referenced by MultipleCriterion::addChild(), MultipleCriterion::checkCriterion(), Criterion::Criterion(), Criterion::getChild(), MultipleCriterion::getChild(), getChild(), MultipleCriterion::getName(), and MultipleCriterion::MultipleCriterion().

~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 AndMultipleCriterion, Criterion, MultipleCriterion, and OrMultipleCriterion.

getChild()

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

pure virtual

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

Implemented in Criterion, and MultipleCriterion.

References getParent(), and StoppingCriterion().

getName()

virtual std::string StoppingCriterion::getName ( )

pure virtual

get stopping criterion name

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

getNumberOfChildren()

virtual int StoppingCriterion::getNumberOfChildren ( )

pure virtual

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

Implemented in Criterion, and MultipleCriterion.

getParent()

MultipleCriterion * StoppingCriterion::getParent

(

)

get parent multiple criteria

References parent.

Referenced by getChild().

Member Data Documentation

monitoringManager

MonitoringManager* StoppingCriterion::monitoringManager

protected

monitoring manager

Referenced by AndMultipleCriterion::AndMultipleCriterion(), Criterion::Criterion(), ForceCriterion::ForceCriterion(), kineticEnergy::kineticEnergy(), MultipleCriterion::MultipleCriterion(), OrMultipleCriterion::OrMultipleCriterion(), Position::Position(), StoppingCriterion(), Time::Time(), and Velocity::Velocity().

parent

MultipleCriterion* StoppingCriterion::parent

protected

parent stopping Criterion

Referenced by AndMultipleCriterion::AndMultipleCriterion(), Criterion::Criterion(), ForceCriterion::ForceCriterion(), getParent(), kineticEnergy::kineticEnergy(), MultipleCriterion::MultipleCriterion(), OrMultipleCriterion::OrMultipleCriterion(), Position::Position(), StoppingCriterion(), Time::Time(), and Velocity::Velocity().

---

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

• StoppingCriterion.h
• StoppingCriterion.cpp