BALL::ComposedEnergyProcessor Class Reference
[Miscellaneous]

A class for composed energy calculations. More...

#include <composedEnergyProcessor.h>

Inheritance diagram for BALL::ComposedEnergyProcessor:
Inheritance graph
[legend]

List of all members.


Public Member Functions

Constructors and destructors
ComposedEnergyProcessor ()
Default constructor.
ComposedEnergyProcessor (const ComposedEnergyProcessor &composed_energy_proc)
Copy constructor.
ComposedEnergyProcessor (EnergyProcessorList proc_list)
Detailed constructor.
virtual ~ComposedEnergyProcessor ()
Destructor.
Assignment
const ComposedEnergyProcessor & operator= (const ComposedEnergyProcessor &proc)
Assignment operator.
virtual void clear ()
Clear method.
Processor functions
virtual bool finish ()
Do all calculations and sum up the different energy contributions.
Accessors
void addComponent (EnergyProcessor *proc)
Add a component to the list of EnergyProcessors.
void removeComponent (EnergyProcessor *proc)
remove a component from the list
Size getNumberOfEnergyProcessors () const
Get number of added EnergyProcessors.
Predicates
bool operator== (const ComposedEnergyProcessor &proc) const
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 BALL::ComposedEnergyProcessor::clear ( ) [virtual]

Clear method.

Clears the calculated energy and the list of processors.

Reimplemented from BALL::EnergyProcessor.


Generated on Thu Aug 6 18:30:28 2009 for BALL by doxygen 1.5.8