Computer Assited Medical Intervention Tool Kit  version 5.0
Position Class Reference

A simple criterion based on position calculation. More...

#include <Position.h>

+ Inheritance diagram for Position:
+ Collaboration diagram for Position:

Public Member Functions

std::string getName () override
 get stopping criterion name More...
 
 Position (mml::Position *c, MonitoringManager *monitoringManager, MultipleCriterion *parent=nullptr)
 constructor More...
 
 ~Position () override
 destructor More...
 
- Public Member Functions inherited from Criterion
bool checkCriterion () override
 return true if the criterion is reach More...
 
 Criterion (mml::Criteria *c, MonitoringManager *monitoringManager, MultipleCriterion *parent=nullptr)
 constructor More...
 
StoppingCriteriongetChild (const unsigned int i) override
 get the child repered by index, return null if no child More...
 
std::string getMethodString ()
 get Method Name More...
 
int getNumberOfChildren () override
 get number of childre; return -1 for non multiple criteria More...
 
std::string scopeToString ()
 get Method scope as string More...
 
 ~Criterion () override
 destructor More...
 
- Public Member Functions inherited from StoppingCriterion
MultipleCriteriongetParent ()
 get parent multiple criteria More...
 
 StoppingCriterion (MonitoringManager *monitoringManager, MultipleCriterion *parent=nullptr)
 constructor More...
 
virtual ~StoppingCriterion ()=default
 destructor More...
 

Private Member Functions

void calculate () override
 calculate stopping criteria data and store it into values vector More...
 

Private Attributes

std::string target
 the monitor targets describe as an LML TargetList string (e.g. "1-4,5"), More...
 

Additional Inherited Members

- Protected Member Functions inherited from Criterion
void write ()
 write values in the mmlOut file More...
 
- Protected Attributes inherited from Criterion
double factor
 factor to multiplate for conversion to SI More...
 
mml::Criteria * mappedObject
 the xsdcxx object representing criterion, used for serialization More...
 
Methodmeth
 the computationnal method used to check if criterion is true More...
 
std::string unit
 unit More...
 
std::vector< double > values
 vector that stores current data of the stopping criteria More...
 
- Protected Attributes inherited from StoppingCriterion
MonitoringManagermonitoringManager
 monitoring manager More...
 
MultipleCriterionparent
 parent stopping Criterion More...
 

Detailed Description

A simple criterion based on position calculation.

Constructor & Destructor Documentation

◆ Position()

Position::Position ( mml::Position *  c,
MonitoringManager monitoringManager,
MultipleCriterion parent = nullptr 
)

constructor

Parameters
cthe xsdcxx generated Position criterion

References Criterion::factor, PhysicalModel::getAtoms(), Component::getName(), MonitoringManager::getPml(), StoppingCriterion::monitoringManager, target, and Criterion::unit.

+ Here is the call graph for this function:

◆ ~Position()

Position::~Position ( )
override

destructor

Member Function Documentation

◆ calculate()

void Position::calculate ( )
overrideprivatevirtual

calculate stopping criteria data and store it into values vector

Implements Criterion.

References AtomIterator::begin(), AtomIterator::currentAtom(), distance(), AtomIterator::end(), Criterion::factor, Structure::getIndex(), MonitoringManager::getOldPosition(), MonitoringManager::getPml(), Atom::getPosition(), StoppingCriterion::monitoringManager, AtomIterator::next(), target, Criterion::values, and Criterion::write().

+ Here is the call graph for this function:

◆ getName()

std::string Position::getName ( )
overridevirtual

get stopping criterion name

Implements Criterion.

Member Data Documentation

◆ target

std::string Position::target
private

the monitor targets describe as an LML TargetList string (e.g. "1-4,5"),

See also
TargetList

Referenced by calculate(), and Position().


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