ComposedEnergyProcessor Class Reference
[Miscellaneous]

A class for composed energy calculations. More...

#include <composedEnergyProcessor.h>

Inheritance diagram for ComposedEnergyProcessor:

List of all members.

Public Member Functions
Constructors and destructors
	ComposedEnergyProcessor () throw ()
	Default constructor.
	ComposedEnergyProcessor (const ComposedEnergyProcessor &composed_energy_proc) throw ()
	Copy constructor.
	ComposedEnergyProcessor (EnergyProcessorList proc_list) throw ()
	Detailed constructor.
virtual	~ComposedEnergyProcessor () throw ()
	Destructor.
Assignment
const ComposedEnergyProcessor &	operator= (const ComposedEnergyProcessor &proc) throw ()
	Assignment operator.
virtual void	clear () throw ()
	Clear method.
Processor functions
virtual bool	finish () throw ()
	Do all calculations and sum up the different energy contributions.
Accessors
void	addComponent (EnergyProcessor *proc) throw ()
	Add a component to the list of EnergyProcessors.
void	removeComponent (EnergyProcessor *proc) throw ()
	remove a component from the list
Size	getNumberOfEnergyProcessors () const throw ()
	Get number of added EnergyProcessors.
Predicates
bool	operator== (const ComposedEnergyProcessor &proc) const throw ()
	Equality operator.
Protected Attributes
EnergyProcessorList	components_

---

Detailed Description

A class for composed energy calculations.

Most energies are compositions of several energy contributions. To model this in a convenient way this class is intended to calculate and sum a given list of energy contributions.

See also:

EnergyProcessor

---

Member Function Documentation

virtual void ComposedEnergyProcessor::clear (   )  throw () [virtual]

Clear method. Clears the calculated energy and the list of processors. Reimplemented from EnergyProcessor.

Size ComposedEnergyProcessor::getNumberOfEnergyProcessors (   )  const throw ()

Get number of added EnergyProcessors.