cTDExpandingWindows Class Reference
[Statistical data collection]

#include <cdetect.h>

Inheritance diagram for cTDExpandingWindows:

List of all members.

---

Detailed Description

A transient detection algorithm.

Uses sliding window approach with two windows, and checks the difference of the two averages to see if the transient period is over.

Public Member Functions
Constructors, destructor, assignment.
	cTDExpandingWindows (const cTDExpandingWindows &r)
	cTDExpandingWindows (const char *name=NULL, int reps=3, int minw=4, double wind=1.3, double acc=0.3, PostTDFunc f=NULL, void *p=NULL)
virtual	~cTDExpandingWindows ()
cTDExpandingWindows &	operator= (const cTDExpandingWindows &res)
Redefined cObject member functions.
virtual cTDExpandingWindows *	dup () const
Redefined cTransientDetection member functions.
virtual void	collect (double val)
virtual bool	detected () const
virtual void	reset ()
virtual void	stop ()
virtual void	start ()
Setting up the detection object.
void	setParameters (int reps=3, int minw=4, double wind=1.3, double acc=0.3)

---

Constructor & Destructor Documentation

cTDExpandingWindows::cTDExpandingWindows

(

const cTDExpandingWindows &

r

)

Copy constructor.

cTDExpandingWindows::cTDExpandingWindows	(	const char *	name = NULL,
		int	reps = 3,
		int	minw = 4,
		double	wind = 1.3,
		double	acc = 0.3,
		PostTDFunc	f = NULL,
		void *	p = NULL
	)			[explicit]

Constructor.

virtual cTDExpandingWindows::~cTDExpandingWindows

(

)

[virtual]

Destructor.

---

Member Function Documentation

cTDExpandingWindows& cTDExpandingWindows::operator=

(

const cTDExpandingWindows &

res

)

Assignment operator.

The name member is not copied; see cOwnedObject's operator=() for more details.

virtual cTDExpandingWindows* cTDExpandingWindows::dup

(

)

const [inline, virtual]

Dupping is not implemented for this class.

This function gives an error (throws cRuntimeError) when called.

Reimplemented from cTransientDetection.

virtual void cTDExpandingWindows::collect

(

double

val

)

[virtual]

Updates the detection algorithm with a value.

Implements cTransientDetection.

virtual bool cTDExpandingWindows::detected

(

)

const [inline, virtual]

Returns true if end of transient has been detected.

Implements cTransientDetection.

virtual void cTDExpandingWindows::reset

(

)

[virtual]

Resets detection algorithm.

Implements cTransientDetection.

virtual void cTDExpandingWindows::stop

(

)

[inline, virtual]

Stop detection; further calls to collect() will be ignored.

Implements cTransientDetection.

virtual void cTDExpandingWindows::start

(

)

[inline, virtual]

Start detection; further calls to collect() will update the detection algorithm.

Implements cTransientDetection.

void cTDExpandingWindows::setParameters	(	int	reps = 3,
		int	minw = 4,
		double	wind = 1.3,
		double	acc = 0.3
	)

Sets the parameters of the detection algorithm.

---

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

• cdetect.h