composedEnergyProcessor.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: composedEnergyProcessor.h,v 1.13 2005/12/23 17:01:43 amoll Exp $
//

#ifndef BALL_ENERGY_COMPOSEDENERGYPROCESSOR
#define BALL_ENERGY_COMPOSEDENERGYPROCESSOR

#ifndef BALL_COMMON_H
# include <BALL/common.h>
#endif

#ifndef BALL_ENERGY_ENERGYPROCESSOR_H
# include <BALL/ENERGY/energyProcessor.h>
#endif

namespace BALL
{
  
  typedef std::list<EnergyProcessor*> EnergyProcessorList;

  class BALL_EXPORT ComposedEnergyProcessor
    : public EnergyProcessor
  {

    public:

    BALL_CREATE(ComposedEnergyProcessor)

    

    ComposedEnergyProcessor();

    ComposedEnergyProcessor(const ComposedEnergyProcessor& composed_energy_proc);

    ComposedEnergyProcessor(EnergyProcessorList proc_list);

    virtual ~ComposedEnergyProcessor();



    const ComposedEnergyProcessor& operator = 
      (const ComposedEnergyProcessor& proc);

    virtual void clear();
  

    
    virtual bool finish();



    void addComponent(EnergyProcessor* proc);

    void removeComponent(EnergyProcessor* proc);

    Size getNumberOfEnergyProcessors() const;
    


    bool operator == (const ComposedEnergyProcessor& proc) const;


    protected:

    EnergyProcessorList components_;


    private:

    /*_ check the validity of this instance. If one of the processors in
     * the list is invalid, then this instance of ComposedEnergyProcessor
     * is invalid 
    */
    void checkValidity();

  };
} // namespace BALL
#endif //  BALL_ENERGY_COMPOSEDENERGYPROCESSOR