QMCExtendedProperties Class Reference

Includes the data for a calculation as well as timing data as to when it was gathered. More...

#include <QMCExtendedProperties.h>

List of all members.

Public Member Functions

QMCExtendedProperties ()

Creates and initializes the object.

QMCProperties * getProperties ()

Gets the accumulated statistics in this object.

Stopwatch * getEquilibrationStopwatch ()

Gets the stopwatch for the equilibration phase of the calculation.

Stopwatch * getPropagationStopwatch ()

Gets the stopwatch for the propogation phase of the calculation.

void zeroOut ()

Zeros out statistics and resets the timers.

long getStartingStep ()

Gets the iteration on which this object started to collect statistics.

void setStartingStep (long i)

Sets the step on which this object started to collect statistics.

Private Attributes

QMCProperties properties

All of the data for the calculation.

Stopwatch equilibrationStopwatch

A timer for the equilibration phase of the calculation.

Stopwatch propagationStopwatch

A timer for the propagation phase of the calculation.

long startingStep

The iteration on which this object started to collect statistics.

Detailed Description

Includes the data for a calculation as well as timing data as to when it was gathered.

Definition at line 16 of file QMCExtendedProperties.h.

Constructor & Destructor Documentation

QMCExtendedProperties::QMCExtendedProperties ( )

Creates and initializes the object.

Definition at line 6 of file QMCExtendedProperties.cpp.

References zeroOut().

Member Function Documentation

QMCProperties * QMCExtendedProperties::getProperties ( )

Gets the accumulated statistics in this object.

Returns:: accumulated statistics in this object.

Definition at line 30 of file QMCExtendedProperties.cpp.

References properties.

Referenced by QMCEquilibrationArray::chooseDecorrObject(), QMCEquilibrationArray::getDecorrObjectIndex(), and QMCEquilibrationArray::newSample().

Stopwatch * QMCExtendedProperties::getEquilibrationStopwatch ( )

Gets the stopwatch for the equilibration phase of the calculation.

Returns:: equilibration stopwatch.

Definition at line 20 of file QMCExtendedProperties.cpp.

References equilibrationStopwatch.

Referenced by QMCEquilibrationArray::getEquilibrationStopwatch(), QMCEquilibrationArray::startTimers(), and QMCEquilibrationArray::stopTimers().

Stopwatch * QMCExtendedProperties::getPropagationStopwatch ( )

Gets the stopwatch for the propogation phase of the calculation.

Returns:: propagation stopwatch.

Definition at line 25 of file QMCExtendedProperties.cpp.

References propagationStopwatch.

Referenced by QMCEquilibrationArray::getPropagationStopwatch(), and QMCEquilibrationArray::stopTimers().

void QMCExtendedProperties::zeroOut ( )

Zeros out statistics and resets the timers.

Definition at line 11 of file QMCExtendedProperties.cpp.

References equilibrationStopwatch, propagationStopwatch, properties, Stopwatch::reset(), startingStep, and QMCProperties::zeroOut().

Referenced by QMCExtendedProperties(), QMCEquilibrationArray::readXML(), and QMCEquilibrationArray::zeroOut().

long QMCExtendedProperties::getStartingStep ( )

Gets the iteration on which this object started to collect statistics.

Returns:: starting step for this object.

Definition at line 35 of file QMCExtendedProperties.cpp.

References startingStep.

void QMCExtendedProperties::setStartingStep ( long i )

Sets the step on which this object started to collect statistics.

Parameters:

starting

step for this object.

Definition at line 40 of file QMCExtendedProperties.cpp.

References startingStep.

Referenced by QMCEquilibrationArray::newSample(), QMCEquilibrationArray::readXML(), and QMCEquilibrationArray::zeroOut().

Member Data Documentation

QMCProperties QMCExtendedProperties::properties [private]

All of the data for the calculation.

Definition at line 23 of file QMCExtendedProperties.h.

Referenced by getProperties(), and zeroOut().

Stopwatch QMCExtendedProperties::equilibrationStopwatch [private]

A timer for the equilibration phase of the calculation.

Definition at line 28 of file QMCExtendedProperties.h.

Referenced by getEquilibrationStopwatch(), and zeroOut().

Stopwatch QMCExtendedProperties::propagationStopwatch [private]

A timer for the propagation phase of the calculation.

Definition at line 33 of file QMCExtendedProperties.h.

Referenced by getPropagationStopwatch(), and zeroOut().

long QMCExtendedProperties::startingStep [private]

The iteration on which this object started to collect statistics.

Definition at line 38 of file QMCExtendedProperties.h.

Referenced by getStartingStep(), setStartingStep(), and zeroOut().

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


Public Member Functions
	QMCExtendedProperties ()
	Creates and initializes the object.
QMCProperties *	getProperties ()
	Gets the accumulated statistics in this object.
Stopwatch *	getEquilibrationStopwatch ()
	Gets the stopwatch for the equilibration phase of the calculation.
Stopwatch *	getPropagationStopwatch ()
	Gets the stopwatch for the propogation phase of the calculation.
void	zeroOut ()
	Zeros out statistics and resets the timers.
long	getStartingStep ()
	Gets the iteration on which this object started to collect statistics.
void	setStartingStep (long i)
	Sets the step on which this object started to collect statistics.
Private Attributes
QMCProperties	properties
	All of the data for the calculation.
Stopwatch	equilibrationStopwatch
	A timer for the equilibration phase of the calculation.
Stopwatch	propagationStopwatch
	A timer for the propagation phase of the calculation.
long	startingStep
	The iteration on which this object started to collect statistics.