Computer Assited Medical Intervention Tool Kit  version 4.1
Public Member Functions | Private Attributes | List of all members
Threshold Class Reference

A Threshold method is a method where individualTest is true is the tested double is inferior or equal to a fixed value. More...

#include <Threshold.h>

Inherits Method.

Public Member Functions

bool individualTest (double tested) override
 return true if tested <= value More...
 
 Threshold (mml::Threshold *m)
 constructor More...
 
std::string toString () override
 get Method name More...
 
 ~Threshold () override=default
 destructor More...
 
- Public Member Functions inherited from Method
 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 ~Method ()=default
 destructor More...
 

Private Attributes

mml::Threshold * mappedObject
 the xsdcxx object representing Threshold, used for serialization More...
 
double value
 value of the threshold More...
 

Additional Inherited Members

- Public Types inherited from Method
enum  ScopeType { Any, Average, Sum, None }
 the scope of the method More...
 
- Protected Attributes inherited from Method
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 Threshold method is a method where individualTest is true is the tested double is inferior or equal to a fixed value.

Constructor & Destructor Documentation

◆ Threshold()

Threshold::Threshold ( mml::Threshold *  m)

constructor

Parameters
thexsdcxx generated Threshold class

References value.

◆ ~Threshold()

Threshold::~Threshold ( )
overridedefault

destructor

Member Function Documentation

◆ individualTest()

bool Threshold::individualTest ( double  tested)
overridevirtual

return true if tested <= value

Implements Method.

References value.

◆ toString()

std::string Threshold::toString ( )
overridevirtual

get Method name

Implements Method.

References value.

Member Data Documentation

◆ mappedObject

mml::Threshold* Threshold::mappedObject
private

the xsdcxx object representing Threshold, used for serialization

◆ value

double Threshold::value
private

value of the threshold

Referenced by individualTest(), Threshold(), and toString().


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