Computer Assisted Medical Intervention Tool Kit  version 5.2
Method Class Referenceabstract

A Method represent how to make the boolean assessment with criteria data (a vector of double) More...

#include <Method.h>

+ Inheritance diagram for Method:
+ Collaboration diagram for Method:

Public Types

enum  ScopeType { Any , Average , Sum , None }
 the scope of the method More...
 

Public Member Functions

virtual bool individualTest (double tested)=0
 return true if the double passed the test More...
 
 Method (mml::Method *m)
 constructor More...
 
std::string scopeTosString ()
 get a String of the scope More...
 
virtual bool test (std::vector< double > &values)
 return true if the vector of fouble values passed the test (see scope) More...
 
virtual std::string toString ()=0
 get Method name More...
 
virtual ~Method ()=default
 destructor More...
 

Protected Attributes

ScopeType scope
 scope of the method Any: test is true if all indivitual test are true in the values vector Average: test is true if the indivudal test of values vector's average is true Sum: test is true if the indivudal test of the sum of all double of the values vector is true None: used for monitor wich are not applied to a structural component (ex: time) More...
 

Detailed Description

A Method represent how to make the boolean assessment with criteria data (a vector of double)

Member Enumeration Documentation

◆ ScopeType

the scope of the method

Enumerator
Any 
Average 
Sum 
None 

Constructor & Destructor Documentation

◆ Method()

Method::Method ( mml::Method *  m)

constructor

Parameters
thexsdcxx generated method class

◆ ~Method()

virtual Method::~Method ( )
virtualdefault

destructor

Member Function Documentation

◆ individualTest()

virtual bool Method::individualTest ( double  tested)
pure virtual

return true if the double passed the test

Implemented in TimePeriodThreshold, Threshold, and MinThreshold.

◆ scopeTosString()

std::string Method::scopeTosString ( )

get a String of the scope

References Any, Average, None, and Sum.

Referenced by Criterion::scopeToString().

+ Here is the caller graph for this function:

◆ test()

bool Method::test ( std::vector< double > &  values)
virtual

return true if the vector of fouble values passed the test (see scope)

References Any, Average, None, and Sum.

Referenced by Criterion::checkCriterion().

+ Here is the caller graph for this function:

◆ toString()

virtual std::string Method::toString ( )
pure virtual

get Method name

Implemented in TimePeriodThreshold, Threshold, and MinThreshold.

Referenced by Criterion::getMethodString().

+ Here is the caller graph for this function:

Member Data Documentation

◆ scope

ScopeType Method::scope
protected

scope of the method Any: test is true if all indivitual test are true in the values vector Average: test is true if the indivudal test of values vector's average is true Sum: test is true if the indivudal test of the sum of all double of the values vector is true None: used for monitor wich are not applied to a structural component (ex: time)


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