TimePeriodThreshold Class Reference

A TimePeriodThreshold method is a method where individualTest is true when the tested double is true during a time period defined by a number of iterations. More...

#include <TimePeriodThreshold.h>

Inheritance diagram for TimePeriodThreshold:

Collaboration diagram for TimePeriodThreshold:

Public Member Functions
bool	individualTest (double tested) override
	return true if tested <= value More...
	TimePeriodThreshold (mml::TimePeriodThreshold *m)
	constructor More...
std::string	toString () override
	get Method name More...
	~TimePeriodThreshold () 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
int	increment
	Needed to keep an eye on consecutive win. More...
int	iterations
	number of iterations defining the time period 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 TimePeriodThreshold method is a method where individualTest is true when the tested double is true during a time period defined by a number of iterations.

Constructor & Destructor Documentation

TimePeriodThreshold()

TimePeriodThreshold::TimePeriodThreshold

(

mml::TimePeriodThreshold *

m

)

constructor

Parameters

the	xsdcxx generated TimePeriodThreshold class

References increment, iterations, and value.

~TimePeriodThreshold()

TimePeriodThreshold::~TimePeriodThreshold ( )

overridedefault

destructor

Member Function Documentation

individualTest()

bool TimePeriodThreshold::individualTest ( double  tested )

overridevirtual

return true if tested <= value

Implements Method.

References increment, iterations, and value.

toString()

std::string TimePeriodThreshold::toString ( )

overridevirtual

get Method name

Implements Method.

References value.

Member Data Documentation

increment

int TimePeriodThreshold::increment

private

Needed to keep an eye on consecutive win.

Referenced by individualTest(), and TimePeriodThreshold().

iterations

int TimePeriodThreshold::iterations

private

number of iterations defining the time period

Referenced by individualTest(), and TimePeriodThreshold().

value

double TimePeriodThreshold::value

private

value of the threshold

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

---

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

• TimePeriodThreshold.h
• TimePeriodThreshold.cpp