namespace events class BasicWindowIterator

Basic window iterator

Inheritance:

Public Methods

	BasicWindowIterator () Default constructor
	BasicWindowIterator (const ConstIterator& beg, const ConstIterator& end, int order = 1, const TimeWindow& window = 1.0) Constructor

Protected Methods

void	InitWindow () Init window
void	Increment () Increment operator
int	GetPermutations () const Get number of permutations
void	SetPermutation () Set permutation to window
Window&	GetWindow () Get event window
const Window&	GetWindow () const Get event window

BasicWindowIterator()

Creates an NULL window iterator. Equivalent to an end iterator

BasicWindowIterator(const ConstIterator& beg, const ConstIterator& end, int order = 1, const TimeWindow& window = 1.0)

Creates an window iterator form a an iterator range.

Parameters:

beg - Beginning of event range
end - End of event range
order - Coincidence order
window - Anlysis window (in sec)
offset - Offset of analysis window (in sec)

void InitWindow()

Initializes the window

void Increment()

Increments the iterator

int GetPermutations() const

Gets the number of coincidence permutations for the present event list.

void SetPermutation()

Set the current events in window according to the permutations index.

Window& GetWindow()

Get the event window.

const Window& GetWindow() const

Get the event window.

Direct child classes:

WindowIterator
ConstWindowIterator

Author:

Written June 2001 by Masahiro Ito and Daniel Sigg

Version:

1.0

alphabetic index hierarchy of classes

Please send questions and comments to sigg_d@ligo-wa.caltech.edu

generated by doc++