libthepeg-dev 1.8.0-1 / usr / include / ThePEG / Repository / Strategy.h

// -*- C++ -*-
//
// Strategy.h is a part of ThePEG - Toolkit for HEP Event Generation
// Copyright (C) 1999-2011 Leif Lonnblad
//
// ThePEG is licenced under version 2 of the GPL, see COPYING for details.
// Please respect the MCnet academic guidelines, see GUIDELINES for details.
//
#ifndef ThePEG_Strategy_H
#define ThePEG_Strategy_H
// This is the declaration of the Strategy class.

#include "ThePEG/Config/ThePEG.h"
#include "Strategy.fh"
#include "ThePEG/Interface/Interfaced.h"

namespace ThePEG {

/**
 * The Strategy class represents a general strategy to be assigned to
 * an EventGenerator. It contains a set of default ParticleData
 * objects which takes presedence over the ones in the Repository
 * (although not over the ones in the EventGenerator). It also
 * contains a set of other default objects which are automatically
 * assigned to all Reference and RefVector interfaces which have the
 * InterfaceBase::defaultIfNull() flag set. In this case each of the
 * objects in defaultObjects() are tested in turn, and the first
 * object which has the correct class and can be set will be used.
 *
 * Sub-classes may implement other behaviors by overriding the
 * doinit() function.
 *
 * @see \ref StrategyInterfaces "The interfaces"
 * defined for Strategy.
 * @see EventGenerator
 * @see ParticleData
 * @see Repository
 * @see Reference
 * 
 */
class Strategy: public Interfaced {

public:

  /** @name Access the special objects in this Strategy. */
  //@{
  /**
   * Return the map of local particles indexed by their PDG id number.
   */
  const ParticleMap & particles() const { return theParticles; }

  /**
   * A directory in the repository which will be scanned for particles
   * which will be included as default particles in a run. These
   * particles will be overridden by particles specified in
   * LocalParticles and default particles
   * specified directly in the EventGenerator.
   */
  string localParticlesDir() const;

  /**
   * By default all particles in the Repository are included in a run,
   * although only one particle per PDG id number. If directories are
   * listed here, only particles in these will be considered for
   * inclusion in a run. Only particles which have a PDG id which is
   * not given by particles in localParticlesDir(), particles(), or in
   * EventGenerator::localParticles() will be considered.
   */
  const vector<string> & defaultParticlesDirs() const {
    return theDefaultParticlesDirs;
  }

  /**
   * Return the vector of default objects.
   */
  const vector<IPtr> & defaultObjects() const { return theDefaultObjects; }
  //@}

  /**
   * Return a freeform version string. Client code should not rely on the 
   * string's format. It can be used e.g. to annotate plots.
   */
  virtual const string versionstring() const { return ""; }

public:

  /** @name Functions used by the persistent I/O system. */
  //@{
  /**
   * Function used to write out object persistently.
   * @param os the persistent output stream written to.
   */
  void persistentOutput(PersistentOStream & os) const;

  /**
   * Function used to read in object persistently.
   * @param is the persistent input stream read from.
   * @param version the version number of the object when written.
   */
  void persistentInput(PersistentIStream & is, int version);
  //@}

  /**
   * Standard Init function used to initialize the interface.
   */
  static void Init();

protected:

  /** @name Clone Methods. */
  //@{
  /**
   * Make a simple clone of this object.
   * @return a pointer to the new object.
   */
  virtual IBPtr clone() const;

  /** Make a clone of this object, possibly modifying the cloned object
   * to make it sane.
   * @return a pointer to the new object.
   */
  virtual IBPtr fullclone() const;
  //@}

private:

  /**
   * Return the map of local particles.
   */
  ParticleMap & particles() { return theParticles; }

private:

  /**
   * the map of default particles.
   */
  ParticleMap theParticles;

  /**
   * A directory in the repository which will be scanned for particles
   * which will be included as default particles in a run. These
   * particles will be overridden by particles specified in
   * LocalParticles and default particles
   * specified directly in the EventGenerator.
   */
  string theLocalParticlesDir;

  /**
   * A vector of default objects.
   */
  vector<IPtr> theDefaultObjects;

  /**
   * By default all particles in the Repository are included in a run,
   * although only one particle per PDG id number. If directories are
   * listed in theDefaultParticlesDirs, only particles in these will
   * be considered for inclusion in a run. Only particles which have a
   * PDG id which is not given by particles in localParticlesDir(),
   * particles(), or in EventGenerator::localParticles() will be
   * considered.
   */
  vector<string> theDefaultParticlesDirs;

private:

  /**
   * Utility function used by the interface.
   */
  void setLocalParticles(PDPtr pd, int);

  /**
   * Utility function used by the interface.
   */
  void insLocalParticles(PDPtr pd, int);

  /**
   * Utility function used by the interface.
   */
  void delLocalParticles(int place);

  /**
   * Utility function used by the interface.
   */
  vector<PDPtr> getLocalParticles() const;

  /**
   * Utility function used by the interface.
   */
  void setLocalParticlesDir(string);

  /**
   * Utility function used by the interface.
   */
  void setDefaultParticlesDirs(string,int);

  /**
   * Utility function used by the interface.
   */
  void insDefaultParticlesDirs(string,int);

  /**
   * Utility function used by the interface.
   */
  static bool checkDir(string);

private:

  /**
   * Describe a concrete class with persistent data.
   */
  static ClassDescription<Strategy> initStrategy;

  /**
   *  Private and non-existent assignment operator.
   */
  Strategy & operator=(const Strategy &);

};

/** @cond TRAITSPECIALIZATIONS */

/** This template specialization informs ThePEG about the base classes
 *  of Strategy. */
template <>
struct BaseClassTrait<Strategy,1>: public ClassTraitsType {
  /** Typedef of the first base class of Strategy. */
  typedef Interfaced NthBase;
};

/** This template specialization informs ThePEG about the name of the
 *  Strategy class. */
template <>
struct ClassTraits<Strategy>: public ClassTraitsBase<Strategy> {
  /** Return a platform-independent class name */
  static string className() { return "ThePEG::Strategy"; }
};

/** @endcond */

}

#endif /* ThePEG_Strategy_H */