IMaterialFactory.h

Go to the documentation of this file.

// $Id$
 
// -----------------------------------------------------------------------
// The VGM package of the Virtual Geometry Model
// Copyright (C) 2007, Ivana Hrivnacova
// All rights reserved.
//
// For the licensing terms see vgm/LICENSE.
// Contact: ivana@ipno.in2p3.fr
// -----------------------------------------------------------------------
 
//
 
#ifndef VGM_I_MATERIAL_FACTORY_H
#define VGM_I_MATERIAL_FACTORY_H
 
#include "VGM/materials/IElement.h"
#include "VGM/materials/IMaterial.h"
 
#include <vector>
 
namespace VGM {
 
class IIsotope;
class IElement;
class IMedium;
 
typedef std::vector<IIsotope*> IsotopeStore;
typedef std::vector<IElement*> ElementStore;
typedef std::vector<IMaterial*> MaterialStore;
typedef std::vector<IMedium*> MediumStore;
 
class IMaterialFactory
{
 public:
  virtual ~IMaterialFactory() {}
 
  //
  // methods
  //
  virtual IIsotope* CreateIsotope(
    const std::string& name, int z, int n, double a = 0.) = 0;
 
  virtual IElement* CreateElement(
    const std::string& name, const std::string& symbol, double z, double a) = 0;
 
  virtual IElement* CreateElement(const std::string& name,
    const std::string& symbol, const VGM::IsotopeVector& isotopes,
    const VGM::RelAbundanceVector& relAbundances) = 0;
 
  virtual IElement* CreateElement(int z, bool isotopes = true) = 0;
 
  virtual IMaterial* CreateMaterial(const std::string& name, double density,
    VGM::IElement* element, double radlen, double intlen) = 0;
 
  virtual IMaterial* CreateMaterial(const std::string& name, double density,
    VGM::IElement* element, double radlen, double intlen,
    VGM::MaterialState state, double temperature, double pressure) = 0;
 
  virtual IMaterial* CreateMaterial(const std::string& name, double density,
    const VGM::ElementVector& elements,
    const VGM::MassFractionVector& fractions) = 0;
 
  virtual IMaterial* CreateMaterial(const std::string& name, double density,
    const VGM::ElementVector& elements,
    const VGM::MassFractionVector& fractions, VGM::MaterialState state,
    double temperature, double pressure) = 0;
 
  virtual IMaterial* CreateMaterial(const std::string& name, double density,
    const VGM::ElementVector& elements,
    const VGM::AtomCountVector& atomCounts) = 0;
 
  virtual IMaterial* CreateMaterial(const std::string& name, double density,
    const VGM::ElementVector& elements, const VGM::AtomCountVector& atomCounts,
    VGM::MaterialState state, double temperature, double pressure) = 0;
 
  virtual IMedium* CreateMedium(const std::string& name, int mediumId,
    VGM::IMaterial* material, int nofParameters, double* parameters) = 0;
 
  //
  // access
  //
  virtual std::string Name() const = 0;
  virtual const IsotopeStore& Isotopes() const = 0;
  virtual const ElementStore& Elements() const = 0;
  virtual const MaterialStore& Materials() const = 0;
  virtual const MediumStore& Media() const = 0;
 
  virtual const IIsotope* Isotope(const std::string& name) const = 0;
  virtual const IElement* Element(const std::string& name) const = 0;
  virtual const IMaterial* Material(const std::string& name) const = 0;
  virtual const IMedium* Medium(const std::string& name) const = 0;
 
  //
  // import/export
  //
  virtual bool Import() = 0;
  virtual bool Export(IMaterialFactory* factory) const = 0;
 
  //
  // listings
  //
  virtual void PrintIsotopes() const = 0;
  virtual void PrintElements() const = 0;
  virtual void PrintMaterials() const = 0;
  virtual void PrintMedia() const = 0;
 
  //
  // debug
  //
  virtual void SetDebug(int debug) = 0;
  virtual int Debug() const = 0;
};
} // namespace VGM
 
#endif // VGM_I_MATERIAL_FACTORY_H