BALL::ComposedEnergyProcessor Class Reference
[Miscellaneous]

#include <BALL/ENERGY/composedEnergyProcessor.h>

Inheritance diagram for BALL::ComposedEnergyProcessor:

[legend]

List of all members.

Public Member Functions
Constructors and destructors
	ComposedEnergyProcessor ()
	ComposedEnergyProcessor (const ComposedEnergyProcessor &composed_energy_proc)
	ComposedEnergyProcessor (EnergyProcessorList proc_list)
virtual	~ComposedEnergyProcessor ()
Assignment
const ComposedEnergyProcessor &	operator= (const ComposedEnergyProcessor &proc)
virtual void	clear ()
Processor functions
virtual bool	finish ()
Accessors
void	addComponent (EnergyProcessor *proc)
void	removeComponent (EnergyProcessor *proc)
Size	getNumberOfEnergyProcessors () const
Predicates
bool	operator== (const ComposedEnergyProcessor &proc) const
Protected Attributes
EnergyProcessorList	components_
Private Member Functions
void	checkValidity ()

---

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

Definition at line 34 of file composedEnergyProcessor.h.

---

Constructor & Destructor Documentation

BALL::ComposedEnergyProcessor::ComposedEnergyProcessor

(

)

Default constructor

BALL::ComposedEnergyProcessor::ComposedEnergyProcessor

(

const ComposedEnergyProcessor &

composed_energy_proc

)

Copy constructor

BALL::ComposedEnergyProcessor::ComposedEnergyProcessor

(

EnergyProcessorList

proc_list

)

Detailed constructor

virtual BALL::ComposedEnergyProcessor::~ComposedEnergyProcessor

(

)

[virtual]

Destructor

---

Member Function Documentation

void BALL::ComposedEnergyProcessor::addComponent

(

EnergyProcessor *

proc

)

Add a component to the list of EnergyProcessors

void BALL::ComposedEnergyProcessor::checkValidity

(

)

[private]

virtual void BALL::ComposedEnergyProcessor::clear

(

)

[virtual]

Clear method. Clears the calculated energy and the list of processors.

Reimplemented from BALL::EnergyProcessor.

virtual bool BALL::ComposedEnergyProcessor::finish

(

)

[virtual]

Do all calculations and sum up the different energy contributions

Reimplemented from BALL::UnaryProcessor< AtomContainer >.

Size BALL::ComposedEnergyProcessor::getNumberOfEnergyProcessors

(

)

const

Get number of added EnergyProcessors.

const ComposedEnergyProcessor& BALL::ComposedEnergyProcessor::operator=

(

const ComposedEnergyProcessor &

proc

)

Assignment operator

bool BALL::ComposedEnergyProcessor::operator==

(

const ComposedEnergyProcessor &

proc

)

const

Equality operator

void BALL::ComposedEnergyProcessor::removeComponent

(

EnergyProcessor *

proc

)

remove a component from the list

---

Member Data Documentation

EnergyProcessorList BALL::ComposedEnergyProcessor::components_ [protected]

Definition at line 116 of file composedEnergyProcessor.h.